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