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