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.journal.model;
016    
017    import com.liferay.portal.LocaleException;
018    import com.liferay.portal.kernel.bean.AutoEscape;
019    import com.liferay.portal.kernel.exception.SystemException;
020    import com.liferay.portal.model.AttachedModel;
021    import com.liferay.portal.model.BaseModel;
022    import com.liferay.portal.model.CacheModel;
023    import com.liferay.portal.model.ResourcedModel;
024    import com.liferay.portal.model.StagedGroupedModel;
025    import com.liferay.portal.model.WorkflowedModel;
026    import com.liferay.portal.service.ServiceContext;
027    
028    import com.liferay.portlet.expando.model.ExpandoBridge;
029    
030    import java.io.Serializable;
031    
032    import java.util.Date;
033    import java.util.Locale;
034    import java.util.Map;
035    
036    /**
037     * The base model interface for the JournalArticle service. Represents a row in the "JournalArticle" 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.journal.model.impl.JournalArticleModelImpl} 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.journal.model.impl.JournalArticleImpl}.
041     * </p>
042     *
043     * @author Brian Wing Shun Chan
044     * @see JournalArticle
045     * @see com.liferay.portlet.journal.model.impl.JournalArticleImpl
046     * @see com.liferay.portlet.journal.model.impl.JournalArticleModelImpl
047     * @generated
048     */
049    public interface JournalArticleModel extends AttachedModel,
050            BaseModel<JournalArticle>, ResourcedModel, StagedGroupedModel,
051            WorkflowedModel {
052            /*
053             * NOTE FOR DEVELOPERS:
054             *
055             * Never modify or reference this interface directly. All methods that expect a journal article model instance should use the {@link JournalArticle} interface instead.
056             */
057    
058            /**
059             * Returns the primary key of this journal article.
060             *
061             * @return the primary key of this journal article
062             */
063            public long getPrimaryKey();
064    
065            /**
066             * Sets the primary key of this journal article.
067             *
068             * @param primaryKey the primary key of this journal article
069             */
070            public void setPrimaryKey(long primaryKey);
071    
072            /**
073             * Returns the uuid of this journal article.
074             *
075             * @return the uuid of this journal article
076             */
077            @AutoEscape
078            public String getUuid();
079    
080            /**
081             * Sets the uuid of this journal article.
082             *
083             * @param uuid the uuid of this journal article
084             */
085            public void setUuid(String uuid);
086    
087            /**
088             * Returns the ID of this journal article.
089             *
090             * @return the ID of this journal article
091             */
092            public long getId();
093    
094            /**
095             * Sets the ID of this journal article.
096             *
097             * @param id the ID of this journal article
098             */
099            public void setId(long id);
100    
101            /**
102             * Returns the resource prim key of this journal article.
103             *
104             * @return the resource prim key of this journal article
105             */
106            public long getResourcePrimKey();
107    
108            /**
109             * Sets the resource prim key of this journal article.
110             *
111             * @param resourcePrimKey the resource prim key of this journal article
112             */
113            public void setResourcePrimKey(long resourcePrimKey);
114    
115            public boolean isResourceMain();
116    
117            /**
118             * Returns the group ID of this journal article.
119             *
120             * @return the group ID of this journal article
121             */
122            public long getGroupId();
123    
124            /**
125             * Sets the group ID of this journal article.
126             *
127             * @param groupId the group ID of this journal article
128             */
129            public void setGroupId(long groupId);
130    
131            /**
132             * Returns the company ID of this journal article.
133             *
134             * @return the company ID of this journal article
135             */
136            public long getCompanyId();
137    
138            /**
139             * Sets the company ID of this journal article.
140             *
141             * @param companyId the company ID of this journal article
142             */
143            public void setCompanyId(long companyId);
144    
145            /**
146             * Returns the user ID of this journal article.
147             *
148             * @return the user ID of this journal article
149             */
150            public long getUserId();
151    
152            /**
153             * Sets the user ID of this journal article.
154             *
155             * @param userId the user ID of this journal article
156             */
157            public void setUserId(long userId);
158    
159            /**
160             * Returns the user uuid of this journal article.
161             *
162             * @return the user uuid of this journal article
163             * @throws SystemException if a system exception occurred
164             */
165            public String getUserUuid() throws SystemException;
166    
167            /**
168             * Sets the user uuid of this journal article.
169             *
170             * @param userUuid the user uuid of this journal article
171             */
172            public void setUserUuid(String userUuid);
173    
174            /**
175             * Returns the user name of this journal article.
176             *
177             * @return the user name of this journal article
178             */
179            @AutoEscape
180            public String getUserName();
181    
182            /**
183             * Sets the user name of this journal article.
184             *
185             * @param userName the user name of this journal article
186             */
187            public void setUserName(String userName);
188    
189            /**
190             * Returns the create date of this journal article.
191             *
192             * @return the create date of this journal article
193             */
194            public Date getCreateDate();
195    
196            /**
197             * Sets the create date of this journal article.
198             *
199             * @param createDate the create date of this journal article
200             */
201            public void setCreateDate(Date createDate);
202    
203            /**
204             * Returns the modified date of this journal article.
205             *
206             * @return the modified date of this journal article
207             */
208            public Date getModifiedDate();
209    
210            /**
211             * Sets the modified date of this journal article.
212             *
213             * @param modifiedDate the modified date of this journal article
214             */
215            public void setModifiedDate(Date modifiedDate);
216    
217            /**
218             * Returns the folder ID of this journal article.
219             *
220             * @return the folder ID of this journal article
221             */
222            public long getFolderId();
223    
224            /**
225             * Sets the folder ID of this journal article.
226             *
227             * @param folderId the folder ID of this journal article
228             */
229            public void setFolderId(long folderId);
230    
231            /**
232             * Returns the fully qualified class name of this journal article.
233             *
234             * @return the fully qualified class name of this journal article
235             */
236            public String getClassName();
237    
238            public void setClassName(String className);
239    
240            /**
241             * Returns the class name ID of this journal article.
242             *
243             * @return the class name ID of this journal article
244             */
245            public long getClassNameId();
246    
247            /**
248             * Sets the class name ID of this journal article.
249             *
250             * @param classNameId the class name ID of this journal article
251             */
252            public void setClassNameId(long classNameId);
253    
254            /**
255             * Returns the class p k of this journal article.
256             *
257             * @return the class p k of this journal article
258             */
259            public long getClassPK();
260    
261            /**
262             * Sets the class p k of this journal article.
263             *
264             * @param classPK the class p k of this journal article
265             */
266            public void setClassPK(long classPK);
267    
268            /**
269             * Returns the article ID of this journal article.
270             *
271             * @return the article ID of this journal article
272             */
273            public String getArticleId();
274    
275            /**
276             * Sets the article ID of this journal article.
277             *
278             * @param articleId the article ID of this journal article
279             */
280            public void setArticleId(String articleId);
281    
282            /**
283             * Returns the version of this journal article.
284             *
285             * @return the version of this journal article
286             */
287            public double getVersion();
288    
289            /**
290             * Sets the version of this journal article.
291             *
292             * @param version the version of this journal article
293             */
294            public void setVersion(double version);
295    
296            /**
297             * Returns the title of this journal article.
298             *
299             * @return the title of this journal article
300             */
301            public String getTitle();
302    
303            /**
304             * Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language.
305             *
306             * @param locale the locale of the language
307             * @return the localized title of this journal article
308             */
309            @AutoEscape
310            public String getTitle(Locale locale);
311    
312            /**
313             * Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.
314             *
315             * @param locale the local of the language
316             * @param useDefault whether to use the default language if no localization exists for the requested language
317             * @return the localized title of this journal article. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
318             */
319            @AutoEscape
320            public String getTitle(Locale locale, boolean useDefault);
321    
322            /**
323             * Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language.
324             *
325             * @param languageId the ID of the language
326             * @return the localized title of this journal article
327             */
328            @AutoEscape
329            public String getTitle(String languageId);
330    
331            /**
332             * Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.
333             *
334             * @param languageId the ID of the language
335             * @param useDefault whether to use the default language if no localization exists for the requested language
336             * @return the localized title of this journal article
337             */
338            @AutoEscape
339            public String getTitle(String languageId, boolean useDefault);
340    
341            @AutoEscape
342            public String getTitleCurrentLanguageId();
343    
344            @AutoEscape
345            public String getTitleCurrentValue();
346    
347            /**
348             * Returns a map of the locales and localized titles of this journal article.
349             *
350             * @return the locales and localized titles of this journal article
351             */
352            public Map<Locale, String> getTitleMap();
353    
354            /**
355             * Sets the title of this journal article.
356             *
357             * @param title the title of this journal article
358             */
359            public void setTitle(String title);
360    
361            /**
362             * Sets the localized title of this journal article in the language.
363             *
364             * @param title the localized title of this journal article
365             * @param locale the locale of the language
366             */
367            public void setTitle(String title, Locale locale);
368    
369            /**
370             * Sets the localized title of this journal article in the language, and sets the default locale.
371             *
372             * @param title the localized title of this journal article
373             * @param locale the locale of the language
374             * @param defaultLocale the default locale
375             */
376            public void setTitle(String title, Locale locale, Locale defaultLocale);
377    
378            public void setTitleCurrentLanguageId(String languageId);
379    
380            /**
381             * Sets the localized titles of this journal article from the map of locales and localized titles.
382             *
383             * @param titleMap the locales and localized titles of this journal article
384             */
385            public void setTitleMap(Map<Locale, String> titleMap);
386    
387            /**
388             * Sets the localized titles of this journal article from the map of locales and localized titles, and sets the default locale.
389             *
390             * @param titleMap the locales and localized titles of this journal article
391             * @param defaultLocale the default locale
392             */
393            public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale);
394    
395            /**
396             * Returns the url title of this journal article.
397             *
398             * @return the url title of this journal article
399             */
400            @AutoEscape
401            public String getUrlTitle();
402    
403            /**
404             * Sets the url title of this journal article.
405             *
406             * @param urlTitle the url title of this journal article
407             */
408            public void setUrlTitle(String urlTitle);
409    
410            /**
411             * Returns the description of this journal article.
412             *
413             * @return the description of this journal article
414             */
415            public String getDescription();
416    
417            /**
418             * Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language.
419             *
420             * @param locale the locale of the language
421             * @return the localized description of this journal article
422             */
423            @AutoEscape
424            public String getDescription(Locale locale);
425    
426            /**
427             * Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.
428             *
429             * @param locale the local of the language
430             * @param useDefault whether to use the default language if no localization exists for the requested language
431             * @return the localized description of this journal article. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
432             */
433            @AutoEscape
434            public String getDescription(Locale locale, boolean useDefault);
435    
436            /**
437             * Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language.
438             *
439             * @param languageId the ID of the language
440             * @return the localized description of this journal article
441             */
442            @AutoEscape
443            public String getDescription(String languageId);
444    
445            /**
446             * Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.
447             *
448             * @param languageId the ID of the language
449             * @param useDefault whether to use the default language if no localization exists for the requested language
450             * @return the localized description of this journal article
451             */
452            @AutoEscape
453            public String getDescription(String languageId, boolean useDefault);
454    
455            @AutoEscape
456            public String getDescriptionCurrentLanguageId();
457    
458            @AutoEscape
459            public String getDescriptionCurrentValue();
460    
461            /**
462             * Returns a map of the locales and localized descriptions of this journal article.
463             *
464             * @return the locales and localized descriptions of this journal article
465             */
466            public Map<Locale, String> getDescriptionMap();
467    
468            /**
469             * Sets the description of this journal article.
470             *
471             * @param description the description of this journal article
472             */
473            public void setDescription(String description);
474    
475            /**
476             * Sets the localized description of this journal article in the language.
477             *
478             * @param description the localized description of this journal article
479             * @param locale the locale of the language
480             */
481            public void setDescription(String description, Locale locale);
482    
483            /**
484             * Sets the localized description of this journal article in the language, and sets the default locale.
485             *
486             * @param description the localized description of this journal article
487             * @param locale the locale of the language
488             * @param defaultLocale the default locale
489             */
490            public void setDescription(String description, Locale locale,
491                    Locale defaultLocale);
492    
493            public void setDescriptionCurrentLanguageId(String languageId);
494    
495            /**
496             * Sets the localized descriptions of this journal article from the map of locales and localized descriptions.
497             *
498             * @param descriptionMap the locales and localized descriptions of this journal article
499             */
500            public void setDescriptionMap(Map<Locale, String> descriptionMap);
501    
502            /**
503             * Sets the localized descriptions of this journal article from the map of locales and localized descriptions, and sets the default locale.
504             *
505             * @param descriptionMap the locales and localized descriptions of this journal article
506             * @param defaultLocale the default locale
507             */
508            public void setDescriptionMap(Map<Locale, String> descriptionMap,
509                    Locale defaultLocale);
510    
511            /**
512             * Returns the content of this journal article.
513             *
514             * @return the content of this journal article
515             */
516            @AutoEscape
517            public String getContent();
518    
519            /**
520             * Sets the content of this journal article.
521             *
522             * @param content the content of this journal article
523             */
524            public void setContent(String content);
525    
526            /**
527             * Returns the type of this journal article.
528             *
529             * @return the type of this journal article
530             */
531            @AutoEscape
532            public String getType();
533    
534            /**
535             * Sets the type of this journal article.
536             *
537             * @param type the type of this journal article
538             */
539            public void setType(String type);
540    
541            /**
542             * Returns the structure ID of this journal article.
543             *
544             * @return the structure ID of this journal article
545             */
546            public String getStructureId();
547    
548            /**
549             * Sets the structure ID of this journal article.
550             *
551             * @param structureId the structure ID of this journal article
552             */
553            public void setStructureId(String structureId);
554    
555            /**
556             * Returns the template ID of this journal article.
557             *
558             * @return the template ID of this journal article
559             */
560            public String getTemplateId();
561    
562            /**
563             * Sets the template ID of this journal article.
564             *
565             * @param templateId the template ID of this journal article
566             */
567            public void setTemplateId(String templateId);
568    
569            /**
570             * Returns the layout uuid of this journal article.
571             *
572             * @return the layout uuid of this journal article
573             */
574            @AutoEscape
575            public String getLayoutUuid();
576    
577            /**
578             * Sets the layout uuid of this journal article.
579             *
580             * @param layoutUuid the layout uuid of this journal article
581             */
582            public void setLayoutUuid(String layoutUuid);
583    
584            /**
585             * Returns the display date of this journal article.
586             *
587             * @return the display date of this journal article
588             */
589            public Date getDisplayDate();
590    
591            /**
592             * Sets the display date of this journal article.
593             *
594             * @param displayDate the display date of this journal article
595             */
596            public void setDisplayDate(Date displayDate);
597    
598            /**
599             * Returns the expiration date of this journal article.
600             *
601             * @return the expiration date of this journal article
602             */
603            public Date getExpirationDate();
604    
605            /**
606             * Sets the expiration date of this journal article.
607             *
608             * @param expirationDate the expiration date of this journal article
609             */
610            public void setExpirationDate(Date expirationDate);
611    
612            /**
613             * Returns the review date of this journal article.
614             *
615             * @return the review date of this journal article
616             */
617            public Date getReviewDate();
618    
619            /**
620             * Sets the review date of this journal article.
621             *
622             * @param reviewDate the review date of this journal article
623             */
624            public void setReviewDate(Date reviewDate);
625    
626            /**
627             * Returns the indexable of this journal article.
628             *
629             * @return the indexable of this journal article
630             */
631            public boolean getIndexable();
632    
633            /**
634             * Returns <code>true</code> if this journal article is indexable.
635             *
636             * @return <code>true</code> if this journal article is indexable; <code>false</code> otherwise
637             */
638            public boolean isIndexable();
639    
640            /**
641             * Sets whether this journal article is indexable.
642             *
643             * @param indexable the indexable of this journal article
644             */
645            public void setIndexable(boolean indexable);
646    
647            /**
648             * Returns the small image of this journal article.
649             *
650             * @return the small image of this journal article
651             */
652            public boolean getSmallImage();
653    
654            /**
655             * Returns <code>true</code> if this journal article is small image.
656             *
657             * @return <code>true</code> if this journal article is small image; <code>false</code> otherwise
658             */
659            public boolean isSmallImage();
660    
661            /**
662             * Sets whether this journal article is small image.
663             *
664             * @param smallImage the small image of this journal article
665             */
666            public void setSmallImage(boolean smallImage);
667    
668            /**
669             * Returns the small image ID of this journal article.
670             *
671             * @return the small image ID of this journal article
672             */
673            public long getSmallImageId();
674    
675            /**
676             * Sets the small image ID of this journal article.
677             *
678             * @param smallImageId the small image ID of this journal article
679             */
680            public void setSmallImageId(long smallImageId);
681    
682            /**
683             * Returns the small image u r l of this journal article.
684             *
685             * @return the small image u r l of this journal article
686             */
687            @AutoEscape
688            public String getSmallImageURL();
689    
690            /**
691             * Sets the small image u r l of this journal article.
692             *
693             * @param smallImageURL the small image u r l of this journal article
694             */
695            public void setSmallImageURL(String smallImageURL);
696    
697            /**
698             * Returns the status of this journal article.
699             *
700             * @return the status of this journal article
701             */
702            public int getStatus();
703    
704            /**
705             * Sets the status of this journal article.
706             *
707             * @param status the status of this journal article
708             */
709            public void setStatus(int status);
710    
711            /**
712             * Returns the status by user ID of this journal article.
713             *
714             * @return the status by user ID of this journal article
715             */
716            public long getStatusByUserId();
717    
718            /**
719             * Sets the status by user ID of this journal article.
720             *
721             * @param statusByUserId the status by user ID of this journal article
722             */
723            public void setStatusByUserId(long statusByUserId);
724    
725            /**
726             * Returns the status by user uuid of this journal article.
727             *
728             * @return the status by user uuid of this journal article
729             * @throws SystemException if a system exception occurred
730             */
731            public String getStatusByUserUuid() throws SystemException;
732    
733            /**
734             * Sets the status by user uuid of this journal article.
735             *
736             * @param statusByUserUuid the status by user uuid of this journal article
737             */
738            public void setStatusByUserUuid(String statusByUserUuid);
739    
740            /**
741             * Returns the status by user name of this journal article.
742             *
743             * @return the status by user name of this journal article
744             */
745            @AutoEscape
746            public String getStatusByUserName();
747    
748            /**
749             * Sets the status by user name of this journal article.
750             *
751             * @param statusByUserName the status by user name of this journal article
752             */
753            public void setStatusByUserName(String statusByUserName);
754    
755            /**
756             * Returns the status date of this journal article.
757             *
758             * @return the status date of this journal article
759             */
760            public Date getStatusDate();
761    
762            /**
763             * Sets the status date of this journal article.
764             *
765             * @param statusDate the status date of this journal article
766             */
767            public void setStatusDate(Date statusDate);
768    
769            /**
770             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
771             */
772            public boolean getApproved();
773    
774            /**
775             * Returns <code>true</code> if this journal article is approved.
776             *
777             * @return <code>true</code> if this journal article is approved; <code>false</code> otherwise
778             */
779            public boolean isApproved();
780    
781            /**
782             * Returns <code>true</code> if this journal article is denied.
783             *
784             * @return <code>true</code> if this journal article is denied; <code>false</code> otherwise
785             */
786            public boolean isDenied();
787    
788            /**
789             * Returns <code>true</code> if this journal article is a draft.
790             *
791             * @return <code>true</code> if this journal article is a draft; <code>false</code> otherwise
792             */
793            public boolean isDraft();
794    
795            /**
796             * Returns <code>true</code> if this journal article is expired.
797             *
798             * @return <code>true</code> if this journal article is expired; <code>false</code> otherwise
799             */
800            public boolean isExpired();
801    
802            /**
803             * Returns <code>true</code> if this journal article is inactive.
804             *
805             * @return <code>true</code> if this journal article is inactive; <code>false</code> otherwise
806             */
807            public boolean isInactive();
808    
809            /**
810             * Returns <code>true</code> if this journal article is incomplete.
811             *
812             * @return <code>true</code> if this journal article is incomplete; <code>false</code> otherwise
813             */
814            public boolean isIncomplete();
815    
816            /**
817             * Returns <code>true</code> if this journal article is in the Recycle Bin.
818             *
819             * @return <code>true</code> if this journal article is in the Recycle Bin; <code>false</code> otherwise
820             */
821            public boolean isInTrash();
822    
823            /**
824             * Returns <code>true</code> if this journal article is pending.
825             *
826             * @return <code>true</code> if this journal article is pending; <code>false</code> otherwise
827             */
828            public boolean isPending();
829    
830            /**
831             * Returns <code>true</code> if this journal article is scheduled.
832             *
833             * @return <code>true</code> if this journal article is scheduled; <code>false</code> otherwise
834             */
835            public boolean isScheduled();
836    
837            public boolean isNew();
838    
839            public void setNew(boolean n);
840    
841            public boolean isCachedModel();
842    
843            public void setCachedModel(boolean cachedModel);
844    
845            public boolean isEscapedModel();
846    
847            public Serializable getPrimaryKeyObj();
848    
849            public void setPrimaryKeyObj(Serializable primaryKeyObj);
850    
851            public ExpandoBridge getExpandoBridge();
852    
853            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
854    
855            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
856    
857            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
858    
859            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
860                    throws LocaleException;
861    
862            public Object clone();
863    
864            public int compareTo(JournalArticle journalArticle);
865    
866            public int hashCode();
867    
868            public CacheModel<JournalArticle> toCacheModel();
869    
870            public JournalArticle toEscapedModel();
871    
872            public JournalArticle toUnescapedModel();
873    
874            public String toString();
875    
876            public String toXmlString();
877    }