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