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            @Override
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            @Override
082            public void setUuid(String uuid);
083    
084            /**
085             * Returns the category ID of this message boards category.
086             *
087             * @return the category ID of this message boards category
088             */
089            public long getCategoryId();
090    
091            /**
092             * Sets the category ID of this message boards category.
093             *
094             * @param categoryId the category ID of this message boards category
095             */
096            public void setCategoryId(long categoryId);
097    
098            /**
099             * Returns the group ID of this message boards category.
100             *
101             * @return the group ID of this message boards category
102             */
103            @Override
104            public long getGroupId();
105    
106            /**
107             * Sets the group ID of this message boards category.
108             *
109             * @param groupId the group ID of this message boards category
110             */
111            @Override
112            public void setGroupId(long groupId);
113    
114            /**
115             * Returns the company ID of this message boards category.
116             *
117             * @return the company ID of this message boards category
118             */
119            @Override
120            public long getCompanyId();
121    
122            /**
123             * Sets the company ID of this message boards category.
124             *
125             * @param companyId the company ID of this message boards category
126             */
127            @Override
128            public void setCompanyId(long companyId);
129    
130            /**
131             * Returns the user ID of this message boards category.
132             *
133             * @return the user ID of this message boards category
134             */
135            @Override
136            public long getUserId();
137    
138            /**
139             * Sets the user ID of this message boards category.
140             *
141             * @param userId the user ID of this message boards category
142             */
143            @Override
144            public void setUserId(long userId);
145    
146            /**
147             * Returns the user uuid of this message boards category.
148             *
149             * @return the user uuid of this message boards category
150             * @throws SystemException if a system exception occurred
151             */
152            @Override
153            public String getUserUuid() throws SystemException;
154    
155            /**
156             * Sets the user uuid of this message boards category.
157             *
158             * @param userUuid the user uuid of this message boards category
159             */
160            @Override
161            public void setUserUuid(String userUuid);
162    
163            /**
164             * Returns the user name of this message boards category.
165             *
166             * @return the user name of this message boards category
167             */
168            @AutoEscape
169            @Override
170            public String getUserName();
171    
172            /**
173             * Sets the user name of this message boards category.
174             *
175             * @param userName the user name of this message boards category
176             */
177            @Override
178            public void setUserName(String userName);
179    
180            /**
181             * Returns the create date of this message boards category.
182             *
183             * @return the create date of this message boards category
184             */
185            @Override
186            public Date getCreateDate();
187    
188            /**
189             * Sets the create date of this message boards category.
190             *
191             * @param createDate the create date of this message boards category
192             */
193            @Override
194            public void setCreateDate(Date createDate);
195    
196            /**
197             * Returns the modified date of this message boards category.
198             *
199             * @return the modified date of this message boards category
200             */
201            @Override
202            public Date getModifiedDate();
203    
204            /**
205             * Sets the modified date of this message boards category.
206             *
207             * @param modifiedDate the modified date of this message boards category
208             */
209            @Override
210            public void setModifiedDate(Date modifiedDate);
211    
212            /**
213             * Returns the parent category ID of this message boards category.
214             *
215             * @return the parent category ID of this message boards category
216             */
217            public long getParentCategoryId();
218    
219            /**
220             * Sets the parent category ID of this message boards category.
221             *
222             * @param parentCategoryId the parent category ID of this message boards category
223             */
224            public void setParentCategoryId(long parentCategoryId);
225    
226            /**
227             * Returns the name of this message boards category.
228             *
229             * @return the name of this message boards category
230             */
231            @AutoEscape
232            public String getName();
233    
234            /**
235             * Sets the name of this message boards category.
236             *
237             * @param name the name of this message boards category
238             */
239            public void setName(String name);
240    
241            /**
242             * Returns the description of this message boards category.
243             *
244             * @return the description of this message boards category
245             */
246            @AutoEscape
247            public String getDescription();
248    
249            /**
250             * Sets the description of this message boards category.
251             *
252             * @param description the description of this message boards category
253             */
254            public void setDescription(String description);
255    
256            /**
257             * Returns the display style of this message boards category.
258             *
259             * @return the display style of this message boards category
260             */
261            @AutoEscape
262            public String getDisplayStyle();
263    
264            /**
265             * Sets the display style of this message boards category.
266             *
267             * @param displayStyle the display style of this message boards category
268             */
269            public void setDisplayStyle(String displayStyle);
270    
271            /**
272             * Returns the thread count of this message boards category.
273             *
274             * @return the thread count of this message boards category
275             */
276            public int getThreadCount();
277    
278            /**
279             * Sets the thread count of this message boards category.
280             *
281             * @param threadCount the thread count of this message boards category
282             */
283            public void setThreadCount(int threadCount);
284    
285            /**
286             * Returns the message count of this message boards category.
287             *
288             * @return the message count of this message boards category
289             */
290            public int getMessageCount();
291    
292            /**
293             * Sets the message count of this message boards category.
294             *
295             * @param messageCount the message count of this message boards category
296             */
297            public void setMessageCount(int messageCount);
298    
299            /**
300             * Returns the last post date of this message boards category.
301             *
302             * @return the last post date of this message boards category
303             */
304            public Date getLastPostDate();
305    
306            /**
307             * Sets the last post date of this message boards category.
308             *
309             * @param lastPostDate the last post date of this message boards category
310             */
311            public void setLastPostDate(Date lastPostDate);
312    
313            /**
314             * Returns the status of this message boards category.
315             *
316             * @return the status of this message boards category
317             */
318            @Override
319            public int getStatus();
320    
321            /**
322             * Sets the status of this message boards category.
323             *
324             * @param status the status of this message boards category
325             */
326            @Override
327            public void setStatus(int status);
328    
329            /**
330             * Returns the status by user ID of this message boards category.
331             *
332             * @return the status by user ID of this message boards category
333             */
334            @Override
335            public long getStatusByUserId();
336    
337            /**
338             * Sets the status by user ID of this message boards category.
339             *
340             * @param statusByUserId the status by user ID of this message boards category
341             */
342            @Override
343            public void setStatusByUserId(long statusByUserId);
344    
345            /**
346             * Returns the status by user uuid of this message boards category.
347             *
348             * @return the status by user uuid of this message boards category
349             * @throws SystemException if a system exception occurred
350             */
351            @Override
352            public String getStatusByUserUuid() throws SystemException;
353    
354            /**
355             * Sets the status by user uuid of this message boards category.
356             *
357             * @param statusByUserUuid the status by user uuid of this message boards category
358             */
359            @Override
360            public void setStatusByUserUuid(String statusByUserUuid);
361    
362            /**
363             * Returns the status by user name of this message boards category.
364             *
365             * @return the status by user name of this message boards category
366             */
367            @AutoEscape
368            @Override
369            public String getStatusByUserName();
370    
371            /**
372             * Sets the status by user name of this message boards category.
373             *
374             * @param statusByUserName the status by user name of this message boards category
375             */
376            @Override
377            public void setStatusByUserName(String statusByUserName);
378    
379            /**
380             * Returns the status date of this message boards category.
381             *
382             * @return the status date of this message boards category
383             */
384            @Override
385            public Date getStatusDate();
386    
387            /**
388             * Sets the status date of this message boards category.
389             *
390             * @param statusDate the status date of this message boards category
391             */
392            @Override
393            public void setStatusDate(Date statusDate);
394    
395            /**
396             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
397             */
398            @Override
399            public boolean getApproved();
400    
401            /**
402             * Returns <code>true</code> if this message boards category is approved.
403             *
404             * @return <code>true</code> if this message boards category is approved; <code>false</code> otherwise
405             */
406            @Override
407            public boolean isApproved();
408    
409            /**
410             * Returns <code>true</code> if this message boards category is denied.
411             *
412             * @return <code>true</code> if this message boards category is denied; <code>false</code> otherwise
413             */
414            @Override
415            public boolean isDenied();
416    
417            /**
418             * Returns <code>true</code> if this message boards category is a draft.
419             *
420             * @return <code>true</code> if this message boards category is a draft; <code>false</code> otherwise
421             */
422            @Override
423            public boolean isDraft();
424    
425            /**
426             * Returns <code>true</code> if this message boards category is expired.
427             *
428             * @return <code>true</code> if this message boards category is expired; <code>false</code> otherwise
429             */
430            @Override
431            public boolean isExpired();
432    
433            /**
434             * Returns <code>true</code> if this message boards category is inactive.
435             *
436             * @return <code>true</code> if this message boards category is inactive; <code>false</code> otherwise
437             */
438            @Override
439            public boolean isInactive();
440    
441            /**
442             * Returns <code>true</code> if this message boards category is incomplete.
443             *
444             * @return <code>true</code> if this message boards category is incomplete; <code>false</code> otherwise
445             */
446            @Override
447            public boolean isIncomplete();
448    
449            /**
450             * Returns <code>true</code> if this message boards category is in the Recycle Bin.
451             *
452             * @return <code>true</code> if this message boards category is in the Recycle Bin; <code>false</code> otherwise
453             */
454            @Override
455            public boolean isInTrash();
456    
457            /**
458             * Returns <code>true</code> if this message boards category is pending.
459             *
460             * @return <code>true</code> if this message boards category is pending; <code>false</code> otherwise
461             */
462            @Override
463            public boolean isPending();
464    
465            /**
466             * Returns <code>true</code> if this message boards category is scheduled.
467             *
468             * @return <code>true</code> if this message boards category is scheduled; <code>false</code> otherwise
469             */
470            @Override
471            public boolean isScheduled();
472    
473            /**
474             * Returns the container model ID of this message boards category.
475             *
476             * @return the container model ID of this message boards category
477             */
478            @Override
479            public long getContainerModelId();
480    
481            /**
482             * Sets the container model ID of this message boards category.
483             *
484             * @param container model ID of this message boards category
485             */
486            @Override
487            public void setContainerModelId(long containerModelId);
488    
489            /**
490             * Returns the container name of this message boards category.
491             *
492             * @return the container name of this message boards category
493             */
494            @Override
495            public String getContainerModelName();
496    
497            /**
498             * Returns the parent container model ID of this message boards category.
499             *
500             * @return the parent container model ID of this message boards category
501             */
502            @Override
503            public long getParentContainerModelId();
504    
505            /**
506             * Sets the parent container model ID of this message boards category.
507             *
508             * @param parent container model ID of this message boards category
509             */
510            @Override
511            public void setParentContainerModelId(long parentContainerModelId);
512    
513            @Override
514            public boolean isNew();
515    
516            @Override
517            public void setNew(boolean n);
518    
519            @Override
520            public boolean isCachedModel();
521    
522            @Override
523            public void setCachedModel(boolean cachedModel);
524    
525            @Override
526            public boolean isEscapedModel();
527    
528            @Override
529            public Serializable getPrimaryKeyObj();
530    
531            @Override
532            public void setPrimaryKeyObj(Serializable primaryKeyObj);
533    
534            @Override
535            public ExpandoBridge getExpandoBridge();
536    
537            @Override
538            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
539    
540            @Override
541            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
542    
543            @Override
544            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
545    
546            @Override
547            public Object clone();
548    
549            @Override
550            public int compareTo(MBCategory mbCategory);
551    
552            @Override
553            public int hashCode();
554    
555            @Override
556            public CacheModel<MBCategory> toCacheModel();
557    
558            @Override
559            public MBCategory toEscapedModel();
560    
561            @Override
562            public MBCategory toUnescapedModel();
563    
564            @Override
565            public String toString();
566    
567            @Override
568            public String toXmlString();
569    }