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