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.WorkflowedModel;
022    import com.liferay.portal.service.ServiceContext;
023    
024    import com.liferay.portlet.expando.model.ExpandoBridge;
025    
026    import java.io.Serializable;
027    
028    import java.util.Date;
029    
030    /**
031     * 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.
032     *
033     * <p>
034     * 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}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see MBThread
039     * @see com.liferay.portlet.messageboards.model.impl.MBThreadImpl
040     * @see com.liferay.portlet.messageboards.model.impl.MBThreadModelImpl
041     * @generated
042     */
043    public interface MBThreadModel extends BaseModel<MBThread>, WorkflowedModel {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. All methods that expect a message boards thread model instance should use the {@link MBThread} interface instead.
048             */
049    
050            /**
051             * Returns the primary key of this message boards thread.
052             *
053             * @return the primary key of this message boards thread
054             */
055            public long getPrimaryKey();
056    
057            /**
058             * Sets the primary key of this message boards thread.
059             *
060             * @param primaryKey the primary key of this message boards thread
061             */
062            public void setPrimaryKey(long primaryKey);
063    
064            /**
065             * Returns the thread ID of this message boards thread.
066             *
067             * @return the thread ID of this message boards thread
068             */
069            public long getThreadId();
070    
071            /**
072             * Sets the thread ID of this message boards thread.
073             *
074             * @param threadId the thread ID of this message boards thread
075             */
076            public void setThreadId(long threadId);
077    
078            /**
079             * Returns the group ID of this message boards thread.
080             *
081             * @return the group ID of this message boards thread
082             */
083            public long getGroupId();
084    
085            /**
086             * Sets the group ID of this message boards thread.
087             *
088             * @param groupId the group ID of this message boards thread
089             */
090            public void setGroupId(long groupId);
091    
092            /**
093             * Returns the company ID of this message boards thread.
094             *
095             * @return the company ID of this message boards thread
096             */
097            public long getCompanyId();
098    
099            /**
100             * Sets the company ID of this message boards thread.
101             *
102             * @param companyId the company ID of this message boards thread
103             */
104            public void setCompanyId(long companyId);
105    
106            /**
107             * Returns the category ID of this message boards thread.
108             *
109             * @return the category ID of this message boards thread
110             */
111            public long getCategoryId();
112    
113            /**
114             * Sets the category ID of this message boards thread.
115             *
116             * @param categoryId the category ID of this message boards thread
117             */
118            public void setCategoryId(long categoryId);
119    
120            /**
121             * Returns the root message ID of this message boards thread.
122             *
123             * @return the root message ID of this message boards thread
124             */
125            public long getRootMessageId();
126    
127            /**
128             * Sets the root message ID of this message boards thread.
129             *
130             * @param rootMessageId the root message ID of this message boards thread
131             */
132            public void setRootMessageId(long rootMessageId);
133    
134            /**
135             * Returns the root message user ID of this message boards thread.
136             *
137             * @return the root message user ID of this message boards thread
138             */
139            public long getRootMessageUserId();
140    
141            /**
142             * Sets the root message user ID of this message boards thread.
143             *
144             * @param rootMessageUserId the root message user ID of this message boards thread
145             */
146            public void setRootMessageUserId(long rootMessageUserId);
147    
148            /**
149             * Returns the root message user uuid of this message boards thread.
150             *
151             * @return the root message user uuid of this message boards thread
152             * @throws SystemException if a system exception occurred
153             */
154            public String getRootMessageUserUuid() throws SystemException;
155    
156            /**
157             * Sets the root message user uuid of this message boards thread.
158             *
159             * @param rootMessageUserUuid the root message user uuid of this message boards thread
160             */
161            public void setRootMessageUserUuid(String rootMessageUserUuid);
162    
163            /**
164             * Returns the message count of this message boards thread.
165             *
166             * @return the message count of this message boards thread
167             */
168            public int getMessageCount();
169    
170            /**
171             * Sets the message count of this message boards thread.
172             *
173             * @param messageCount the message count of this message boards thread
174             */
175            public void setMessageCount(int messageCount);
176    
177            /**
178             * Returns the view count of this message boards thread.
179             *
180             * @return the view count of this message boards thread
181             */
182            public int getViewCount();
183    
184            /**
185             * Sets the view count of this message boards thread.
186             *
187             * @param viewCount the view count of this message boards thread
188             */
189            public void setViewCount(int viewCount);
190    
191            /**
192             * Returns the last post by user ID of this message boards thread.
193             *
194             * @return the last post by user ID of this message boards thread
195             */
196            public long getLastPostByUserId();
197    
198            /**
199             * Sets the last post by user ID of this message boards thread.
200             *
201             * @param lastPostByUserId the last post by user ID of this message boards thread
202             */
203            public void setLastPostByUserId(long lastPostByUserId);
204    
205            /**
206             * Returns the last post by user uuid of this message boards thread.
207             *
208             * @return the last post by user uuid of this message boards thread
209             * @throws SystemException if a system exception occurred
210             */
211            public String getLastPostByUserUuid() throws SystemException;
212    
213            /**
214             * Sets the last post by user uuid of this message boards thread.
215             *
216             * @param lastPostByUserUuid the last post by user uuid of this message boards thread
217             */
218            public void setLastPostByUserUuid(String lastPostByUserUuid);
219    
220            /**
221             * Returns the last post date of this message boards thread.
222             *
223             * @return the last post date of this message boards thread
224             */
225            public Date getLastPostDate();
226    
227            /**
228             * Sets the last post date of this message boards thread.
229             *
230             * @param lastPostDate the last post date of this message boards thread
231             */
232            public void setLastPostDate(Date lastPostDate);
233    
234            /**
235             * Returns the priority of this message boards thread.
236             *
237             * @return the priority of this message boards thread
238             */
239            public double getPriority();
240    
241            /**
242             * Sets the priority of this message boards thread.
243             *
244             * @param priority the priority of this message boards thread
245             */
246            public void setPriority(double priority);
247    
248            /**
249             * Returns the question of this message boards thread.
250             *
251             * @return the question of this message boards thread
252             */
253            public boolean getQuestion();
254    
255            /**
256             * Returns <code>true</code> if this message boards thread is question.
257             *
258             * @return <code>true</code> if this message boards thread is question; <code>false</code> otherwise
259             */
260            public boolean isQuestion();
261    
262            /**
263             * Sets whether this message boards thread is question.
264             *
265             * @param question the question of this message boards thread
266             */
267            public void setQuestion(boolean question);
268    
269            /**
270             * Returns the status of this message boards thread.
271             *
272             * @return the status of this message boards thread
273             */
274            public int getStatus();
275    
276            /**
277             * Sets the status of this message boards thread.
278             *
279             * @param status the status of this message boards thread
280             */
281            public void setStatus(int status);
282    
283            /**
284             * Returns the status by user ID of this message boards thread.
285             *
286             * @return the status by user ID of this message boards thread
287             */
288            public long getStatusByUserId();
289    
290            /**
291             * Sets the status by user ID of this message boards thread.
292             *
293             * @param statusByUserId the status by user ID of this message boards thread
294             */
295            public void setStatusByUserId(long statusByUserId);
296    
297            /**
298             * Returns the status by user uuid of this message boards thread.
299             *
300             * @return the status by user uuid of this message boards thread
301             * @throws SystemException if a system exception occurred
302             */
303            public String getStatusByUserUuid() throws SystemException;
304    
305            /**
306             * Sets the status by user uuid of this message boards thread.
307             *
308             * @param statusByUserUuid the status by user uuid of this message boards thread
309             */
310            public void setStatusByUserUuid(String statusByUserUuid);
311    
312            /**
313             * Returns the status by user name of this message boards thread.
314             *
315             * @return the status by user name of this message boards thread
316             */
317            @AutoEscape
318            public String getStatusByUserName();
319    
320            /**
321             * Sets the status by user name of this message boards thread.
322             *
323             * @param statusByUserName the status by user name of this message boards thread
324             */
325            public void setStatusByUserName(String statusByUserName);
326    
327            /**
328             * Returns the status date of this message boards thread.
329             *
330             * @return the status date of this message boards thread
331             */
332            public Date getStatusDate();
333    
334            /**
335             * Sets the status date of this message boards thread.
336             *
337             * @param statusDate the status date of this message boards thread
338             */
339            public void setStatusDate(Date statusDate);
340    
341            /**
342             * @deprecated Renamed to {@link #isApproved()}
343             */
344            public boolean getApproved();
345    
346            /**
347             * Returns <code>true</code> if this message boards thread is approved.
348             *
349             * @return <code>true</code> if this message boards thread is approved; <code>false</code> otherwise
350             */
351            public boolean isApproved();
352    
353            /**
354             * Returns <code>true</code> if this message boards thread is denied.
355             *
356             * @return <code>true</code> if this message boards thread is denied; <code>false</code> otherwise
357             */
358            public boolean isDenied();
359    
360            /**
361             * Returns <code>true</code> if this message boards thread is a draft.
362             *
363             * @return <code>true</code> if this message boards thread is a draft; <code>false</code> otherwise
364             */
365            public boolean isDraft();
366    
367            /**
368             * Returns <code>true</code> if this message boards thread is expired.
369             *
370             * @return <code>true</code> if this message boards thread is expired; <code>false</code> otherwise
371             */
372            public boolean isExpired();
373    
374            /**
375             * Returns <code>true</code> if this message boards thread is inactive.
376             *
377             * @return <code>true</code> if this message boards thread is inactive; <code>false</code> otherwise
378             */
379            public boolean isInactive();
380    
381            /**
382             * Returns <code>true</code> if this message boards thread is incomplete.
383             *
384             * @return <code>true</code> if this message boards thread is incomplete; <code>false</code> otherwise
385             */
386            public boolean isIncomplete();
387    
388            /**
389             * Returns <code>true</code> if this message boards thread is pending.
390             *
391             * @return <code>true</code> if this message boards thread is pending; <code>false</code> otherwise
392             */
393            public boolean isPending();
394    
395            /**
396             * Returns <code>true</code> if this message boards thread is scheduled.
397             *
398             * @return <code>true</code> if this message boards thread is scheduled; <code>false</code> otherwise
399             */
400            public boolean isScheduled();
401    
402            public boolean isNew();
403    
404            public void setNew(boolean n);
405    
406            public boolean isCachedModel();
407    
408            public void setCachedModel(boolean cachedModel);
409    
410            public boolean isEscapedModel();
411    
412            public Serializable getPrimaryKeyObj();
413    
414            public void setPrimaryKeyObj(Serializable primaryKeyObj);
415    
416            public ExpandoBridge getExpandoBridge();
417    
418            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
419    
420            public Object clone();
421    
422            public int compareTo(MBThread mbThread);
423    
424            public int hashCode();
425    
426            public CacheModel<MBThread> toCacheModel();
427    
428            public MBThread toEscapedModel();
429    
430            public MBThread toUnescapedModel();
431    
432            public String toString();
433    
434            public String toXmlString();
435    }