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