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