001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.messageboards.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.model.ContainerModel;
022    import com.liferay.portal.model.GroupedModel;
023    import com.liferay.portal.model.StagedModel;
024    import com.liferay.portal.model.WorkflowedModel;
025    import com.liferay.portal.service.ServiceContext;
026    
027    import com.liferay.portlet.expando.model.ExpandoBridge;
028    
029    import java.io.Serializable;
030    
031    import java.util.Date;
032    
033    /**
034     * The base model interface for the MBCategory service. Represents a row in the "MBCategory" database table, with each column mapped to a property of this class.
035     *
036     * <p>
037     * This interface and its corresponding implementation {@link com.liferay.portlet.messageboards.model.impl.MBCategoryModelImpl} exist only as a container for the default property accessors generated by ServiceBuilder. Helper methods and all application logic should be put in {@link com.liferay.portlet.messageboards.model.impl.MBCategoryImpl}.
038     * </p>
039     *
040     * @author Brian Wing Shun Chan
041     * @see MBCategory
042     * @see com.liferay.portlet.messageboards.model.impl.MBCategoryImpl
043     * @see com.liferay.portlet.messageboards.model.impl.MBCategoryModelImpl
044     * @generated
045     */
046    public interface MBCategoryModel extends BaseModel<MBCategory>, ContainerModel,
047            GroupedModel, StagedModel, WorkflowedModel {
048            /*
049             * NOTE FOR DEVELOPERS:
050             *
051             * Never modify or reference this interface directly. All methods that expect a message boards category model instance should use the {@link MBCategory} interface instead.
052             */
053    
054            /**
055             * Returns the primary key of this message boards category.
056             *
057             * @return the primary key of this message boards category
058             */
059            public long getPrimaryKey();
060    
061            /**
062             * Sets the primary key of this message boards category.
063             *
064             * @param primaryKey the primary key of this message boards category
065             */
066            public void setPrimaryKey(long primaryKey);
067    
068            /**
069             * Returns the uuid of this message boards category.
070             *
071             * @return the uuid of this message boards category
072             */
073            @AutoEscape
074            public String getUuid();
075    
076            /**
077             * Sets the uuid of this message boards category.
078             *
079             * @param uuid the uuid of this message boards category
080             */
081            public void setUuid(String uuid);
082    
083            /**
084             * Returns the category ID of this message boards category.
085             *
086             * @return the category ID of this message boards category
087             */
088            public long getCategoryId();
089    
090            /**
091             * Sets the category ID of this message boards category.
092             *
093             * @param categoryId the category ID of this message boards category
094             */
095            public void setCategoryId(long categoryId);
096    
097            /**
098             * Returns the group ID of this message boards category.
099             *
100             * @return the group ID of this message boards category
101             */
102            public long getGroupId();
103    
104            /**
105             * Sets the group ID of this message boards category.
106             *
107             * @param groupId the group ID of this message boards category
108             */
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this message boards category.
113             *
114             * @return the company ID of this message boards category
115             */
116            public long getCompanyId();
117    
118            /**
119             * Sets the company ID of this message boards category.
120             *
121             * @param companyId the company ID of this message boards category
122             */
123            public void setCompanyId(long companyId);
124    
125            /**
126             * Returns the user ID of this message boards category.
127             *
128             * @return the user ID of this message boards category
129             */
130            public long getUserId();
131    
132            /**
133             * Sets the user ID of this message boards category.
134             *
135             * @param userId the user ID of this message boards category
136             */
137            public void setUserId(long userId);
138    
139            /**
140             * Returns the user uuid of this message boards category.
141             *
142             * @return the user uuid of this message boards category
143             * @throws SystemException if a system exception occurred
144             */
145            public String getUserUuid() throws SystemException;
146    
147            /**
148             * Sets the user uuid of this message boards category.
149             *
150             * @param userUuid the user uuid of this message boards category
151             */
152            public void setUserUuid(String userUuid);
153    
154            /**
155             * Returns the user name of this message boards category.
156             *
157             * @return the user name of this message boards category
158             */
159            @AutoEscape
160            public String getUserName();
161    
162            /**
163             * Sets the user name of this message boards category.
164             *
165             * @param userName the user name of this message boards category
166             */
167            public void setUserName(String userName);
168    
169            /**
170             * Returns the create date of this message boards category.
171             *
172             * @return the create date of this message boards category
173             */
174            public Date getCreateDate();
175    
176            /**
177             * Sets the create date of this message boards category.
178             *
179             * @param createDate the create date of this message boards category
180             */
181            public void setCreateDate(Date createDate);
182    
183            /**
184             * Returns the modified date of this message boards category.
185             *
186             * @return the modified date of this message boards category
187             */
188            public Date getModifiedDate();
189    
190            /**
191             * Sets the modified date of this message boards category.
192             *
193             * @param modifiedDate the modified date of this message boards category
194             */
195            public void setModifiedDate(Date modifiedDate);
196    
197            /**
198             * Returns the parent category ID of this message boards category.
199             *
200             * @return the parent category ID of this message boards category
201             */
202            public long getParentCategoryId();
203    
204            /**
205             * Sets the parent category ID of this message boards category.
206             *
207             * @param parentCategoryId the parent category ID of this message boards category
208             */
209            public void setParentCategoryId(long parentCategoryId);
210    
211            /**
212             * Returns the name of this message boards category.
213             *
214             * @return the name of this message boards category
215             */
216            @AutoEscape
217            public String getName();
218    
219            /**
220             * Sets the name of this message boards category.
221             *
222             * @param name the name of this message boards category
223             */
224            public void setName(String name);
225    
226            /**
227             * Returns the description of this message boards category.
228             *
229             * @return the description of this message boards category
230             */
231            @AutoEscape
232            public String getDescription();
233    
234            /**
235             * Sets the description of this message boards category.
236             *
237             * @param description the description of this message boards category
238             */
239            public void setDescription(String description);
240    
241            /**
242             * Returns the display style of this message boards category.
243             *
244             * @return the display style of this message boards category
245             */
246            @AutoEscape
247            public String getDisplayStyle();
248    
249            /**
250             * Sets the display style of this message boards category.
251             *
252             * @param displayStyle the display style of this message boards category
253             */
254            public void setDisplayStyle(String displayStyle);
255    
256            /**
257             * Returns the thread count of this message boards category.
258             *
259             * @return the thread count of this message boards category
260             */
261            public int getThreadCount();
262    
263            /**
264             * Sets the thread count of this message boards category.
265             *
266             * @param threadCount the thread count of this message boards category
267             */
268            public void setThreadCount(int threadCount);
269    
270            /**
271             * Returns the message count of this message boards category.
272             *
273             * @return the message count of this message boards category
274             */
275            public int getMessageCount();
276    
277            /**
278             * Sets the message count of this message boards category.
279             *
280             * @param messageCount the message count of this message boards category
281             */
282            public void setMessageCount(int messageCount);
283    
284            /**
285             * Returns the last post date of this message boards category.
286             *
287             * @return the last post date of this message boards category
288             */
289            public Date getLastPostDate();
290    
291            /**
292             * Sets the last post date of this message boards category.
293             *
294             * @param lastPostDate the last post date of this message boards category
295             */
296            public void setLastPostDate(Date lastPostDate);
297    
298            /**
299             * Returns the status of this message boards category.
300             *
301             * @return the status of this message boards category
302             */
303            public int getStatus();
304    
305            /**
306             * Sets the status of this message boards category.
307             *
308             * @param status the status of this message boards category
309             */
310            public void setStatus(int status);
311    
312            /**
313             * Returns the status by user ID of this message boards category.
314             *
315             * @return the status by user ID of this message boards category
316             */
317            public long getStatusByUserId();
318    
319            /**
320             * Sets the status by user ID of this message boards category.
321             *
322             * @param statusByUserId the status by user ID of this message boards category
323             */
324            public void setStatusByUserId(long statusByUserId);
325    
326            /**
327             * Returns the status by user uuid of this message boards category.
328             *
329             * @return the status by user uuid of this message boards category
330             * @throws SystemException if a system exception occurred
331             */
332            public String getStatusByUserUuid() throws SystemException;
333    
334            /**
335             * Sets the status by user uuid of this message boards category.
336             *
337             * @param statusByUserUuid the status by user uuid of this message boards category
338             */
339            public void setStatusByUserUuid(String statusByUserUuid);
340    
341            /**
342             * Returns the status by user name of this message boards category.
343             *
344             * @return the status by user name of this message boards category
345             */
346            @AutoEscape
347            public String getStatusByUserName();
348    
349            /**
350             * Sets the status by user name of this message boards category.
351             *
352             * @param statusByUserName the status by user name of this message boards category
353             */
354            public void setStatusByUserName(String statusByUserName);
355    
356            /**
357             * Returns the status date of this message boards category.
358             *
359             * @return the status date of this message boards category
360             */
361            public Date getStatusDate();
362    
363            /**
364             * Sets the status date of this message boards category.
365             *
366             * @param statusDate the status date of this message boards category
367             */
368            public void setStatusDate(Date statusDate);
369    
370            /**
371             * @deprecated Renamed to {@link #isApproved()}
372             */
373            public boolean getApproved();
374    
375            /**
376             * Returns <code>true</code> if this message boards category is approved.
377             *
378             * @return <code>true</code> if this message boards category is approved; <code>false</code> otherwise
379             */
380            public boolean isApproved();
381    
382            /**
383             * Returns <code>true</code> if this message boards category is denied.
384             *
385             * @return <code>true</code> if this message boards category is denied; <code>false</code> otherwise
386             */
387            public boolean isDenied();
388    
389            /**
390             * Returns <code>true</code> if this message boards category is a draft.
391             *
392             * @return <code>true</code> if this message boards category is a draft; <code>false</code> otherwise
393             */
394            public boolean isDraft();
395    
396            /**
397             * Returns <code>true</code> if this message boards category is expired.
398             *
399             * @return <code>true</code> if this message boards category is expired; <code>false</code> otherwise
400             */
401            public boolean isExpired();
402    
403            /**
404             * Returns <code>true</code> if this message boards category is inactive.
405             *
406             * @return <code>true</code> if this message boards category is inactive; <code>false</code> otherwise
407             */
408            public boolean isInactive();
409    
410            /**
411             * Returns <code>true</code> if this message boards category is incomplete.
412             *
413             * @return <code>true</code> if this message boards category is incomplete; <code>false</code> otherwise
414             */
415            public boolean isIncomplete();
416    
417            /**
418             * Returns <code>true</code> if this message boards category is in the Recycle Bin.
419             *
420             * @return <code>true</code> if this message boards category is in the Recycle Bin; <code>false</code> otherwise
421             */
422            public boolean isInTrash();
423    
424            /**
425             * Returns <code>true</code> if this message boards category is pending.
426             *
427             * @return <code>true</code> if this message boards category is pending; <code>false</code> otherwise
428             */
429            public boolean isPending();
430    
431            /**
432             * Returns <code>true</code> if this message boards category is scheduled.
433             *
434             * @return <code>true</code> if this message boards category is scheduled; <code>false</code> otherwise
435             */
436            public boolean isScheduled();
437    
438            /**
439             * Returns the container model ID of this message boards category.
440             *
441             * @return the container model ID of this message boards category
442             */
443            public long getContainerModelId();
444    
445            /**
446             * Sets the container model ID of this message boards category.
447             *
448             * @param container model ID of this message boards category
449             */
450            public void setContainerModelId(long containerModelId);
451    
452            /**
453             * Returns the container name of this message boards category.
454             *
455             * @return the container name of this message boards category
456             */
457            public String getContainerModelName();
458    
459            /**
460             * Returns the parent container model ID of this message boards category.
461             *
462             * @return the parent container model ID of this message boards category
463             */
464            public long getParentContainerModelId();
465    
466            /**
467             * Sets the parent container model ID of this message boards category.
468             *
469             * @param parent container model ID of this message boards category
470             */
471            public void setParentContainerModelId(long parentContainerModelId);
472    
473            public boolean isNew();
474    
475            public void setNew(boolean n);
476    
477            public boolean isCachedModel();
478    
479            public void setCachedModel(boolean cachedModel);
480    
481            public boolean isEscapedModel();
482    
483            public Serializable getPrimaryKeyObj();
484    
485            public void setPrimaryKeyObj(Serializable primaryKeyObj);
486    
487            public ExpandoBridge getExpandoBridge();
488    
489            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
490    
491            public Object clone();
492    
493            public int compareTo(MBCategory mbCategory);
494    
495            public int hashCode();
496    
497            public CacheModel<MBCategory> toCacheModel();
498    
499            public MBCategory toEscapedModel();
500    
501            public MBCategory toUnescapedModel();
502    
503            public String toString();
504    
505            public String toXmlString();
506    }