001    /**
002     * Copyright (c) 2000-2012 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.AttachedModel;
020    import com.liferay.portal.model.BaseModel;
021    import com.liferay.portal.model.CacheModel;
022    import com.liferay.portal.model.GroupedModel;
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 MBMessage service. Represents a row in the "MBMessage" 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.MBMessageModelImpl} 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.MBMessageImpl}.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see MBMessage
041     * @see com.liferay.portlet.messageboards.model.impl.MBMessageImpl
042     * @see com.liferay.portlet.messageboards.model.impl.MBMessageModelImpl
043     * @generated
044     */
045    public interface MBMessageModel extends AttachedModel, BaseModel<MBMessage>,
046            GroupedModel, WorkflowedModel {
047            /*
048             * NOTE FOR DEVELOPERS:
049             *
050             * Never modify or reference this interface directly. All methods that expect a message-boards message model instance should use the {@link MBMessage} interface instead.
051             */
052    
053            /**
054             * Returns the primary key of this message-boards message.
055             *
056             * @return the primary key of this message-boards message
057             */
058            public long getPrimaryKey();
059    
060            /**
061             * Sets the primary key of this message-boards message.
062             *
063             * @param primaryKey the primary key of this message-boards message
064             */
065            public void setPrimaryKey(long primaryKey);
066    
067            /**
068             * Returns the uuid of this message-boards message.
069             *
070             * @return the uuid of this message-boards message
071             */
072            @AutoEscape
073            public String getUuid();
074    
075            /**
076             * Sets the uuid of this message-boards message.
077             *
078             * @param uuid the uuid of this message-boards message
079             */
080            public void setUuid(String uuid);
081    
082            /**
083             * Returns the message ID of this message-boards message.
084             *
085             * @return the message ID of this message-boards message
086             */
087            public long getMessageId();
088    
089            /**
090             * Sets the message ID of this message-boards message.
091             *
092             * @param messageId the message ID of this message-boards message
093             */
094            public void setMessageId(long messageId);
095    
096            /**
097             * Returns the group ID of this message-boards message.
098             *
099             * @return the group ID of this message-boards message
100             */
101            public long getGroupId();
102    
103            /**
104             * Sets the group ID of this message-boards message.
105             *
106             * @param groupId the group ID of this message-boards message
107             */
108            public void setGroupId(long groupId);
109    
110            /**
111             * Returns the company ID of this message-boards message.
112             *
113             * @return the company ID of this message-boards message
114             */
115            public long getCompanyId();
116    
117            /**
118             * Sets the company ID of this message-boards message.
119             *
120             * @param companyId the company ID of this message-boards message
121             */
122            public void setCompanyId(long companyId);
123    
124            /**
125             * Returns the user ID of this message-boards message.
126             *
127             * @return the user ID of this message-boards message
128             */
129            public long getUserId();
130    
131            /**
132             * Sets the user ID of this message-boards message.
133             *
134             * @param userId the user ID of this message-boards message
135             */
136            public void setUserId(long userId);
137    
138            /**
139             * Returns the user uuid of this message-boards message.
140             *
141             * @return the user uuid of this message-boards message
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 message.
148             *
149             * @param userUuid the user uuid of this message-boards message
150             */
151            public void setUserUuid(String userUuid);
152    
153            /**
154             * Returns the user name of this message-boards message.
155             *
156             * @return the user name of this message-boards message
157             */
158            @AutoEscape
159            public String getUserName();
160    
161            /**
162             * Sets the user name of this message-boards message.
163             *
164             * @param userName the user name of this message-boards message
165             */
166            public void setUserName(String userName);
167    
168            /**
169             * Returns the create date of this message-boards message.
170             *
171             * @return the create date of this message-boards message
172             */
173            public Date getCreateDate();
174    
175            /**
176             * Sets the create date of this message-boards message.
177             *
178             * @param createDate the create date of this message-boards message
179             */
180            public void setCreateDate(Date createDate);
181    
182            /**
183             * Returns the modified date of this message-boards message.
184             *
185             * @return the modified date of this message-boards message
186             */
187            public Date getModifiedDate();
188    
189            /**
190             * Sets the modified date of this message-boards message.
191             *
192             * @param modifiedDate the modified date of this message-boards message
193             */
194            public void setModifiedDate(Date modifiedDate);
195    
196            /**
197             * Returns the fully qualified class name of this message-boards message.
198             *
199             * @return the fully qualified class name of this message-boards message
200             */
201            public String getClassName();
202    
203            /**
204             * Returns the class name ID of this message-boards message.
205             *
206             * @return the class name ID of this message-boards message
207             */
208            public long getClassNameId();
209    
210            /**
211             * Sets the class name ID of this message-boards message.
212             *
213             * @param classNameId the class name ID of this message-boards message
214             */
215            public void setClassNameId(long classNameId);
216    
217            /**
218             * Returns the class p k of this message-boards message.
219             *
220             * @return the class p k of this message-boards message
221             */
222            public long getClassPK();
223    
224            /**
225             * Sets the class p k of this message-boards message.
226             *
227             * @param classPK the class p k of this message-boards message
228             */
229            public void setClassPK(long classPK);
230    
231            /**
232             * Returns the category ID of this message-boards message.
233             *
234             * @return the category ID of this message-boards message
235             */
236            public long getCategoryId();
237    
238            /**
239             * Sets the category ID of this message-boards message.
240             *
241             * @param categoryId the category ID of this message-boards message
242             */
243            public void setCategoryId(long categoryId);
244    
245            /**
246             * Returns the thread ID of this message-boards message.
247             *
248             * @return the thread ID of this message-boards message
249             */
250            public long getThreadId();
251    
252            /**
253             * Sets the thread ID of this message-boards message.
254             *
255             * @param threadId the thread ID of this message-boards message
256             */
257            public void setThreadId(long threadId);
258    
259            /**
260             * Returns the root message ID of this message-boards message.
261             *
262             * @return the root message ID of this message-boards message
263             */
264            public long getRootMessageId();
265    
266            /**
267             * Sets the root message ID of this message-boards message.
268             *
269             * @param rootMessageId the root message ID of this message-boards message
270             */
271            public void setRootMessageId(long rootMessageId);
272    
273            /**
274             * Returns the parent message ID of this message-boards message.
275             *
276             * @return the parent message ID of this message-boards message
277             */
278            public long getParentMessageId();
279    
280            /**
281             * Sets the parent message ID of this message-boards message.
282             *
283             * @param parentMessageId the parent message ID of this message-boards message
284             */
285            public void setParentMessageId(long parentMessageId);
286    
287            /**
288             * Returns the subject of this message-boards message.
289             *
290             * @return the subject of this message-boards message
291             */
292            @AutoEscape
293            public String getSubject();
294    
295            /**
296             * Sets the subject of this message-boards message.
297             *
298             * @param subject the subject of this message-boards message
299             */
300            public void setSubject(String subject);
301    
302            /**
303             * Returns the body of this message-boards message.
304             *
305             * @return the body of this message-boards message
306             */
307            @AutoEscape
308            public String getBody();
309    
310            /**
311             * Sets the body of this message-boards message.
312             *
313             * @param body the body of this message-boards message
314             */
315            public void setBody(String body);
316    
317            /**
318             * Returns the format of this message-boards message.
319             *
320             * @return the format of this message-boards message
321             */
322            @AutoEscape
323            public String getFormat();
324    
325            /**
326             * Sets the format of this message-boards message.
327             *
328             * @param format the format of this message-boards message
329             */
330            public void setFormat(String format);
331    
332            /**
333             * Returns the attachments of this message-boards message.
334             *
335             * @return the attachments of this message-boards message
336             */
337            public boolean getAttachments();
338    
339            /**
340             * Returns <code>true</code> if this message-boards message is attachments.
341             *
342             * @return <code>true</code> if this message-boards message is attachments; <code>false</code> otherwise
343             */
344            public boolean isAttachments();
345    
346            /**
347             * Sets whether this message-boards message is attachments.
348             *
349             * @param attachments the attachments of this message-boards message
350             */
351            public void setAttachments(boolean attachments);
352    
353            /**
354             * Returns the anonymous of this message-boards message.
355             *
356             * @return the anonymous of this message-boards message
357             */
358            public boolean getAnonymous();
359    
360            /**
361             * Returns <code>true</code> if this message-boards message is anonymous.
362             *
363             * @return <code>true</code> if this message-boards message is anonymous; <code>false</code> otherwise
364             */
365            public boolean isAnonymous();
366    
367            /**
368             * Sets whether this message-boards message is anonymous.
369             *
370             * @param anonymous the anonymous of this message-boards message
371             */
372            public void setAnonymous(boolean anonymous);
373    
374            /**
375             * Returns the priority of this message-boards message.
376             *
377             * @return the priority of this message-boards message
378             */
379            public double getPriority();
380    
381            /**
382             * Sets the priority of this message-boards message.
383             *
384             * @param priority the priority of this message-boards message
385             */
386            public void setPriority(double priority);
387    
388            /**
389             * Returns the allow pingbacks of this message-boards message.
390             *
391             * @return the allow pingbacks of this message-boards message
392             */
393            public boolean getAllowPingbacks();
394    
395            /**
396             * Returns <code>true</code> if this message-boards message is allow pingbacks.
397             *
398             * @return <code>true</code> if this message-boards message is allow pingbacks; <code>false</code> otherwise
399             */
400            public boolean isAllowPingbacks();
401    
402            /**
403             * Sets whether this message-boards message is allow pingbacks.
404             *
405             * @param allowPingbacks the allow pingbacks of this message-boards message
406             */
407            public void setAllowPingbacks(boolean allowPingbacks);
408    
409            /**
410             * Returns the answer of this message-boards message.
411             *
412             * @return the answer of this message-boards message
413             */
414            public boolean getAnswer();
415    
416            /**
417             * Returns <code>true</code> if this message-boards message is answer.
418             *
419             * @return <code>true</code> if this message-boards message is answer; <code>false</code> otherwise
420             */
421            public boolean isAnswer();
422    
423            /**
424             * Sets whether this message-boards message is answer.
425             *
426             * @param answer the answer of this message-boards message
427             */
428            public void setAnswer(boolean answer);
429    
430            /**
431             * Returns the status of this message-boards message.
432             *
433             * @return the status of this message-boards message
434             */
435            public int getStatus();
436    
437            /**
438             * Sets the status of this message-boards message.
439             *
440             * @param status the status of this message-boards message
441             */
442            public void setStatus(int status);
443    
444            /**
445             * Returns the status by user ID of this message-boards message.
446             *
447             * @return the status by user ID of this message-boards message
448             */
449            public long getStatusByUserId();
450    
451            /**
452             * Sets the status by user ID of this message-boards message.
453             *
454             * @param statusByUserId the status by user ID of this message-boards message
455             */
456            public void setStatusByUserId(long statusByUserId);
457    
458            /**
459             * Returns the status by user uuid of this message-boards message.
460             *
461             * @return the status by user uuid of this message-boards message
462             * @throws SystemException if a system exception occurred
463             */
464            public String getStatusByUserUuid() throws SystemException;
465    
466            /**
467             * Sets the status by user uuid of this message-boards message.
468             *
469             * @param statusByUserUuid the status by user uuid of this message-boards message
470             */
471            public void setStatusByUserUuid(String statusByUserUuid);
472    
473            /**
474             * Returns the status by user name of this message-boards message.
475             *
476             * @return the status by user name of this message-boards message
477             */
478            @AutoEscape
479            public String getStatusByUserName();
480    
481            /**
482             * Sets the status by user name of this message-boards message.
483             *
484             * @param statusByUserName the status by user name of this message-boards message
485             */
486            public void setStatusByUserName(String statusByUserName);
487    
488            /**
489             * Returns the status date of this message-boards message.
490             *
491             * @return the status date of this message-boards message
492             */
493            public Date getStatusDate();
494    
495            /**
496             * Sets the status date of this message-boards message.
497             *
498             * @param statusDate the status date of this message-boards message
499             */
500            public void setStatusDate(Date statusDate);
501    
502            /**
503             * @deprecated Renamed to {@link #isApproved()}
504             */
505            public boolean getApproved();
506    
507            /**
508             * Returns <code>true</code> if this message-boards message is approved.
509             *
510             * @return <code>true</code> if this message-boards message is approved; <code>false</code> otherwise
511             */
512            public boolean isApproved();
513    
514            /**
515             * Returns <code>true</code> if this message-boards message is a draft.
516             *
517             * @return <code>true</code> if this message-boards message is a draft; <code>false</code> otherwise
518             */
519            public boolean isDraft();
520    
521            /**
522             * Returns <code>true</code> if this message-boards message is expired.
523             *
524             * @return <code>true</code> if this message-boards message is expired; <code>false</code> otherwise
525             */
526            public boolean isExpired();
527    
528            /**
529             * Returns <code>true</code> if this message-boards message is pending.
530             *
531             * @return <code>true</code> if this message-boards message is pending; <code>false</code> otherwise
532             */
533            public boolean isPending();
534    
535            public boolean isNew();
536    
537            public void setNew(boolean n);
538    
539            public boolean isCachedModel();
540    
541            public void setCachedModel(boolean cachedModel);
542    
543            public boolean isEscapedModel();
544    
545            public Serializable getPrimaryKeyObj();
546    
547            public void setPrimaryKeyObj(Serializable primaryKeyObj);
548    
549            public ExpandoBridge getExpandoBridge();
550    
551            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
552    
553            public Object clone();
554    
555            public int compareTo(MBMessage mbMessage);
556    
557            public int hashCode();
558    
559            public CacheModel<MBMessage> toCacheModel();
560    
561            public MBMessage toEscapedModel();
562    
563            public String toString();
564    
565            public String toXmlString();
566    }