001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.messageboards.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.model.ContainerModel;
022    import com.liferay.portal.model.StagedGroupedModel;
023    import com.liferay.portal.model.WorkflowedModel;
024    import com.liferay.portal.service.ServiceContext;
025    
026    import com.liferay.portlet.expando.model.ExpandoBridge;
027    
028    import java.io.Serializable;
029    
030    import java.util.Date;
031    
032    /**
033     * The base model interface for the MBThread service. Represents a row in the "MBThread" database table, with each column mapped to a property of this class.
034     *
035     * <p>
036     * This interface and its corresponding implementation {@link com.liferay.portlet.messageboards.model.impl.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}.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see MBThread
041     * @see com.liferay.portlet.messageboards.model.impl.MBThreadImpl
042     * @see com.liferay.portlet.messageboards.model.impl.MBThreadModelImpl
043     * @generated
044     */
045    public interface MBThreadModel extends BaseModel<MBThread>, ContainerModel,
046            StagedGroupedModel, WorkflowedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. All methods that expect a message boards thread model instance should use the {@link MBThread} interface instead.
051             */
052    
053            /**
054             * Returns the primary key of this message boards thread.
055             *
056             * @return the primary key of this message boards thread
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this message boards thread.
062             *
063             * @param primaryKey the primary key of this message boards thread
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the uuid of this message boards thread.
069             *
070             * @return the uuid of this message boards thread
071             */
072            @AutoEscape
073            public String getUuid();
074    
075            /**
076             * Sets the uuid of this message boards thread.
077             *
078             * @param uuid the uuid of this message boards thread
079             */
080            public void setUuid(String uuid);
081    
082            /**
083             * Returns the thread ID of this message boards thread.
084             *
085             * @return the thread ID of this message boards thread
086             */
087            public long getThreadId();
088    
089            /**
090             * Sets the thread ID of this message boards thread.
091             *
092             * @param threadId the thread ID of this message boards thread
093             */
094            public void setThreadId(long threadId);
095    
096            /**
097             * Returns the group ID of this message boards thread.
098             *
099             * @return the group ID of this message boards thread
100             */
101            public long getGroupId();
102    
103            /**
104             * Sets the group ID of this message boards thread.
105             *
106             * @param groupId the group ID of this message boards thread
107             */
108            public void setGroupId(long groupId);
109    
110            /**
111             * Returns the company ID of this message boards thread.
112             *
113             * @return the company ID of this message boards thread
114             */
115            public long getCompanyId();
116    
117            /**
118             * Sets the company ID of this message boards thread.
119             *
120             * @param companyId the company ID of this message boards thread
121             */
122            public void setCompanyId(long companyId);
123    
124            /**
125             * Returns the user ID of this message boards thread.
126             *
127             * @return the user ID of this message boards thread
128             */
129            public long getUserId();
130    
131            /**
132             * Sets the user ID of this message boards thread.
133             *
134             * @param userId the user ID of this message boards thread
135             */
136            public void setUserId(long userId);
137    
138            /**
139             * Returns the user uuid of this message boards thread.
140             *
141             * @return the user uuid of this message boards thread
142             * @throws SystemException if a system exception occurred
143             */
144            public String getUserUuid() throws SystemException;
145    
146            /**
147             * Sets the user uuid of this message boards thread.
148             *
149             * @param userUuid the user uuid of this message boards thread
150             */
151            public void setUserUuid(String userUuid);
152    
153            /**
154             * Returns the user name of this message boards thread.
155             *
156             * @return the user name of this message boards thread
157             */
158            @AutoEscape
159            public String getUserName();
160    
161            /**
162             * Sets the user name of this message boards thread.
163             *
164             * @param userName the user name of this message boards thread
165             */
166            public void setUserName(String userName);
167    
168            /**
169             * Returns the create date of this message boards thread.
170             *
171             * @return the create date of this message boards thread
172             */
173            public Date getCreateDate();
174    
175            /**
176             * Sets the create date of this message boards thread.
177             *
178             * @param createDate the create date of this message boards thread
179             */
180            public void setCreateDate(Date createDate);
181    
182            /**
183             * Returns the modified date of this message boards thread.
184             *
185             * @return the modified date of this message boards thread
186             */
187            public Date getModifiedDate();
188    
189            /**
190             * Sets the modified date of this message boards thread.
191             *
192             * @param modifiedDate the modified date of this message boards thread
193             */
194            public void setModifiedDate(Date modifiedDate);
195    
196            /**
197             * Returns the category ID of this message boards thread.
198             *
199             * @return the category ID of this message boards thread
200             */
201            public long getCategoryId();
202    
203            /**
204             * Sets the category ID of this message boards thread.
205             *
206             * @param categoryId the category ID of this message boards thread
207             */
208            public void setCategoryId(long categoryId);
209    
210            /**
211             * Returns the root message ID of this message boards thread.
212             *
213             * @return the root message ID of this message boards thread
214             */
215            public long getRootMessageId();
216    
217            /**
218             * Sets the root message ID of this message boards thread.
219             *
220             * @param rootMessageId the root message ID of this message boards thread
221             */
222            public void setRootMessageId(long rootMessageId);
223    
224            /**
225             * Returns the root message user ID of this message boards thread.
226             *
227             * @return the root message user ID of this message boards thread
228             */
229            public long getRootMessageUserId();
230    
231            /**
232             * Sets the root message user ID of this message boards thread.
233             *
234             * @param rootMessageUserId the root message user ID of this message boards thread
235             */
236            public void setRootMessageUserId(long rootMessageUserId);
237    
238            /**
239             * Returns the root message user uuid of this message boards thread.
240             *
241             * @return the root message user uuid of this message boards thread
242             * @throws SystemException if a system exception occurred
243             */
244            public String getRootMessageUserUuid() throws SystemException;
245    
246            /**
247             * Sets the root message user uuid of this message boards thread.
248             *
249             * @param rootMessageUserUuid the root message user uuid of this message boards thread
250             */
251            public void setRootMessageUserUuid(String rootMessageUserUuid);
252    
253            /**
254             * Returns the message count of this message boards thread.
255             *
256             * @return the message count of this message boards thread
257             */
258            public int getMessageCount();
259    
260            /**
261             * Sets the message count of this message boards thread.
262             *
263             * @param messageCount the message count of this message boards thread
264             */
265            public void setMessageCount(int messageCount);
266    
267            /**
268             * Returns the view count of this message boards thread.
269             *
270             * @return the view count of this message boards thread
271             */
272            public int getViewCount();
273    
274            /**
275             * Sets the view count of this message boards thread.
276             *
277             * @param viewCount the view count of this message boards thread
278             */
279            public void setViewCount(int viewCount);
280    
281            /**
282             * Returns the last post by user ID of this message boards thread.
283             *
284             * @return the last post by user ID of this message boards thread
285             */
286            public long getLastPostByUserId();
287    
288            /**
289             * Sets the last post by user ID of this message boards thread.
290             *
291             * @param lastPostByUserId the last post by user ID of this message boards thread
292             */
293            public void setLastPostByUserId(long lastPostByUserId);
294    
295            /**
296             * Returns the last post by user uuid of this message boards thread.
297             *
298             * @return the last post by user uuid of this message boards thread
299             * @throws SystemException if a system exception occurred
300             */
301            public String getLastPostByUserUuid() throws SystemException;
302    
303            /**
304             * Sets the last post by user uuid of this message boards thread.
305             *
306             * @param lastPostByUserUuid the last post by user uuid of this message boards thread
307             */
308            public void setLastPostByUserUuid(String lastPostByUserUuid);
309    
310            /**
311             * Returns the last post date of this message boards thread.
312             *
313             * @return the last post date of this message boards thread
314             */
315            public Date getLastPostDate();
316    
317            /**
318             * Sets the last post date of this message boards thread.
319             *
320             * @param lastPostDate the last post date of this message boards thread
321             */
322            public void setLastPostDate(Date lastPostDate);
323    
324            /**
325             * Returns the priority of this message boards thread.
326             *
327             * @return the priority of this message boards thread
328             */
329            public double getPriority();
330    
331            /**
332             * Sets the priority of this message boards thread.
333             *
334             * @param priority the priority of this message boards thread
335             */
336            public void setPriority(double priority);
337    
338            /**
339             * Returns the question of this message boards thread.
340             *
341             * @return the question of this message boards thread
342             */
343            public boolean getQuestion();
344    
345            /**
346             * Returns <code>true</code> if this message boards thread is question.
347             *
348             * @return <code>true</code> if this message boards thread is question; <code>false</code> otherwise
349             */
350            public boolean isQuestion();
351    
352            /**
353             * Sets whether this message boards thread is question.
354             *
355             * @param question the question of this message boards thread
356             */
357            public void setQuestion(boolean question);
358    
359            /**
360             * Returns the status of this message boards thread.
361             *
362             * @return the status of this message boards thread
363             */
364            public int getStatus();
365    
366            /**
367             * Sets the status of this message boards thread.
368             *
369             * @param status the status of this message boards thread
370             */
371            public void setStatus(int status);
372    
373            /**
374             * Returns the status by user ID of this message boards thread.
375             *
376             * @return the status by user ID of this message boards thread
377             */
378            public long getStatusByUserId();
379    
380            /**
381             * Sets the status by user ID of this message boards thread.
382             *
383             * @param statusByUserId the status by user ID of this message boards thread
384             */
385            public void setStatusByUserId(long statusByUserId);
386    
387            /**
388             * Returns the status by user uuid of this message boards thread.
389             *
390             * @return the status by user uuid of this message boards thread
391             * @throws SystemException if a system exception occurred
392             */
393            public String getStatusByUserUuid() throws SystemException;
394    
395            /**
396             * Sets the status by user uuid of this message boards thread.
397             *
398             * @param statusByUserUuid the status by user uuid of this message boards thread
399             */
400            public void setStatusByUserUuid(String statusByUserUuid);
401    
402            /**
403             * Returns the status by user name of this message boards thread.
404             *
405             * @return the status by user name of this message boards thread
406             */
407            @AutoEscape
408            public String getStatusByUserName();
409    
410            /**
411             * Sets the status by user name of this message boards thread.
412             *
413             * @param statusByUserName the status by user name of this message boards thread
414             */
415            public void setStatusByUserName(String statusByUserName);
416    
417            /**
418             * Returns the status date of this message boards thread.
419             *
420             * @return the status date of this message boards thread
421             */
422            public Date getStatusDate();
423    
424            /**
425             * Sets the status date of this message boards thread.
426             *
427             * @param statusDate the status date of this message boards thread
428             */
429            public void setStatusDate(Date statusDate);
430    
431            /**
432             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
433             */
434            public boolean getApproved();
435    
436            /**
437             * Returns <code>true</code> if this message boards thread is approved.
438             *
439             * @return <code>true</code> if this message boards thread is approved; <code>false</code> otherwise
440             */
441            public boolean isApproved();
442    
443            /**
444             * Returns <code>true</code> if this message boards thread is denied.
445             *
446             * @return <code>true</code> if this message boards thread is denied; <code>false</code> otherwise
447             */
448            public boolean isDenied();
449    
450            /**
451             * Returns <code>true</code> if this message boards thread is a draft.
452             *
453             * @return <code>true</code> if this message boards thread is a draft; <code>false</code> otherwise
454             */
455            public boolean isDraft();
456    
457            /**
458             * Returns <code>true</code> if this message boards thread is expired.
459             *
460             * @return <code>true</code> if this message boards thread is expired; <code>false</code> otherwise
461             */
462            public boolean isExpired();
463    
464            /**
465             * Returns <code>true</code> if this message boards thread is inactive.
466             *
467             * @return <code>true</code> if this message boards thread is inactive; <code>false</code> otherwise
468             */
469            public boolean isInactive();
470    
471            /**
472             * Returns <code>true</code> if this message boards thread is incomplete.
473             *
474             * @return <code>true</code> if this message boards thread is incomplete; <code>false</code> otherwise
475             */
476            public boolean isIncomplete();
477    
478            /**
479             * Returns <code>true</code> if this message boards thread is in the Recycle Bin.
480             *
481             * @return <code>true</code> if this message boards thread is in the Recycle Bin; <code>false</code> otherwise
482             */
483            public boolean isInTrash();
484    
485            /**
486             * Returns <code>true</code> if this message boards thread is pending.
487             *
488             * @return <code>true</code> if this message boards thread is pending; <code>false</code> otherwise
489             */
490            public boolean isPending();
491    
492            /**
493             * Returns <code>true</code> if this message boards thread is scheduled.
494             *
495             * @return <code>true</code> if this message boards thread is scheduled; <code>false</code> otherwise
496             */
497            public boolean isScheduled();
498    
499            /**
500             * Returns the container model ID of this message boards thread.
501             *
502             * @return the container model ID of this message boards thread
503             */
504            public long getContainerModelId();
505    
506            /**
507             * Sets the container model ID of this message boards thread.
508             *
509             * @param container model ID of this message boards thread
510             */
511            public void setContainerModelId(long containerModelId);
512    
513            /**
514             * Returns the container name of this message boards thread.
515             *
516             * @return the container name of this message boards thread
517             */
518            public String getContainerModelName();
519    
520            /**
521             * Returns the parent container model ID of this message boards thread.
522             *
523             * @return the parent container model ID of this message boards thread
524             */
525            public long getParentContainerModelId();
526    
527            /**
528             * Sets the parent container model ID of this message boards thread.
529             *
530             * @param parent container model ID of this message boards thread
531             */
532            public void setParentContainerModelId(long parentContainerModelId);
533    
534            public boolean isNew();
535    
536            public void setNew(boolean n);
537    
538            public boolean isCachedModel();
539    
540            public void setCachedModel(boolean cachedModel);
541    
542            public boolean isEscapedModel();
543    
544            public Serializable getPrimaryKeyObj();
545    
546            public void setPrimaryKeyObj(Serializable primaryKeyObj);
547    
548            public ExpandoBridge getExpandoBridge();
549    
550            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
551    
552            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
553    
554            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
555    
556            public Object clone();
557    
558            public int compareTo(MBThread mbThread);
559    
560            public int hashCode();
561    
562            public CacheModel<MBThread> toCacheModel();
563    
564            public MBThread toEscapedModel();
565    
566            public MBThread toUnescapedModel();
567    
568            public String toString();
569    
570            public String toXmlString();
571    }