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