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.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 fully qualified class name of this journal article.
218             *
219             * @return the fully qualified class name of this journal article
220             */
221            public String getClassName();
222    
223            public void setClassName(String className);
224    
225            /**
226             * Returns the class name ID of this journal article.
227             *
228             * @return the class name ID of this journal article
229             */
230            public long getClassNameId();
231    
232            /**
233             * Sets the class name ID of this journal article.
234             *
235             * @param classNameId the class name ID of this journal article
236             */
237            public void setClassNameId(long classNameId);
238    
239            /**
240             * Returns the class p k of this journal article.
241             *
242             * @return the class p k of this journal article
243             */
244            public long getClassPK();
245    
246            /**
247             * Sets the class p k of this journal article.
248             *
249             * @param classPK the class p k of this journal article
250             */
251            public void setClassPK(long classPK);
252    
253            /**
254             * Returns the article ID of this journal article.
255             *
256             * @return the article ID of this journal article
257             */
258            public String getArticleId();
259    
260            /**
261             * Sets the article ID of this journal article.
262             *
263             * @param articleId the article ID of this journal article
264             */
265            public void setArticleId(String articleId);
266    
267            /**
268             * Returns the version of this journal article.
269             *
270             * @return the version of this journal article
271             */
272            public double getVersion();
273    
274            /**
275             * Sets the version of this journal article.
276             *
277             * @param version the version of this journal article
278             */
279            public void setVersion(double version);
280    
281            /**
282             * Returns the title of this journal article.
283             *
284             * @return the title of this journal article
285             */
286            public String getTitle();
287    
288            /**
289             * Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language.
290             *
291             * @param locale the locale of the language
292             * @return the localized title of this journal article
293             */
294            @AutoEscape
295            public String getTitle(Locale locale);
296    
297            /**
298             * Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.
299             *
300             * @param locale the local of the language
301             * @param useDefault whether to use the default language if no localization exists for the requested language
302             * @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.
303             */
304            @AutoEscape
305            public String getTitle(Locale locale, boolean useDefault);
306    
307            /**
308             * Returns the localized title of this journal article in the language. Uses the default language if no localization exists for the requested language.
309             *
310             * @param languageId the ID of the language
311             * @return the localized title of this journal article
312             */
313            @AutoEscape
314            public String getTitle(String languageId);
315    
316            /**
317             * Returns the localized title of this journal article in the language, optionally using the default language if no localization exists for the requested language.
318             *
319             * @param languageId the ID of the language
320             * @param useDefault whether to use the default language if no localization exists for the requested language
321             * @return the localized title of this journal article
322             */
323            @AutoEscape
324            public String getTitle(String languageId, boolean useDefault);
325    
326            @AutoEscape
327            public String getTitleCurrentLanguageId();
328    
329            @AutoEscape
330            public String getTitleCurrentValue();
331    
332            /**
333             * Returns a map of the locales and localized titles of this journal article.
334             *
335             * @return the locales and localized titles of this journal article
336             */
337            public Map<Locale, String> getTitleMap();
338    
339            /**
340             * Sets the title of this journal article.
341             *
342             * @param title the title of this journal article
343             */
344            public void setTitle(String title);
345    
346            /**
347             * Sets the localized title of this journal article in the language.
348             *
349             * @param title the localized title of this journal article
350             * @param locale the locale of the language
351             */
352            public void setTitle(String title, Locale locale);
353    
354            /**
355             * Sets the localized title of this journal article in the language, and sets the default locale.
356             *
357             * @param title the localized title of this journal article
358             * @param locale the locale of the language
359             * @param defaultLocale the default locale
360             */
361            public void setTitle(String title, Locale locale, Locale defaultLocale);
362    
363            public void setTitleCurrentLanguageId(String languageId);
364    
365            /**
366             * Sets the localized titles of this journal article from the map of locales and localized titles.
367             *
368             * @param titleMap the locales and localized titles of this journal article
369             */
370            public void setTitleMap(Map<Locale, String> titleMap);
371    
372            /**
373             * Sets the localized titles of this journal article from the map of locales and localized titles, and sets the default locale.
374             *
375             * @param titleMap the locales and localized titles of this journal article
376             * @param defaultLocale the default locale
377             */
378            public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale);
379    
380            /**
381             * Returns the url title of this journal article.
382             *
383             * @return the url title of this journal article
384             */
385            @AutoEscape
386            public String getUrlTitle();
387    
388            /**
389             * Sets the url title of this journal article.
390             *
391             * @param urlTitle the url title of this journal article
392             */
393            public void setUrlTitle(String urlTitle);
394    
395            /**
396             * Returns the description of this journal article.
397             *
398             * @return the description of this journal article
399             */
400            public String getDescription();
401    
402            /**
403             * Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language.
404             *
405             * @param locale the locale of the language
406             * @return the localized description of this journal article
407             */
408            @AutoEscape
409            public String getDescription(Locale locale);
410    
411            /**
412             * Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.
413             *
414             * @param locale the local of the language
415             * @param useDefault whether to use the default language if no localization exists for the requested language
416             * @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.
417             */
418            @AutoEscape
419            public String getDescription(Locale locale, boolean useDefault);
420    
421            /**
422             * Returns the localized description of this journal article in the language. Uses the default language if no localization exists for the requested language.
423             *
424             * @param languageId the ID of the language
425             * @return the localized description of this journal article
426             */
427            @AutoEscape
428            public String getDescription(String languageId);
429    
430            /**
431             * Returns the localized description of this journal article in the language, optionally using the default language if no localization exists for the requested language.
432             *
433             * @param languageId the ID of the language
434             * @param useDefault whether to use the default language if no localization exists for the requested language
435             * @return the localized description of this journal article
436             */
437            @AutoEscape
438            public String getDescription(String languageId, boolean useDefault);
439    
440            @AutoEscape
441            public String getDescriptionCurrentLanguageId();
442    
443            @AutoEscape
444            public String getDescriptionCurrentValue();
445    
446            /**
447             * Returns a map of the locales and localized descriptions of this journal article.
448             *
449             * @return the locales and localized descriptions of this journal article
450             */
451            public Map<Locale, String> getDescriptionMap();
452    
453            /**
454             * Sets the description of this journal article.
455             *
456             * @param description the description of this journal article
457             */
458            public void setDescription(String description);
459    
460            /**
461             * Sets the localized description of this journal article in the language.
462             *
463             * @param description the localized description of this journal article
464             * @param locale the locale of the language
465             */
466            public void setDescription(String description, Locale locale);
467    
468            /**
469             * Sets the localized description of this journal article in the language, and sets the default locale.
470             *
471             * @param description the localized description of this journal article
472             * @param locale the locale of the language
473             * @param defaultLocale the default locale
474             */
475            public void setDescription(String description, Locale locale,
476                    Locale defaultLocale);
477    
478            public void setDescriptionCurrentLanguageId(String languageId);
479    
480            /**
481             * Sets the localized descriptions of this journal article from the map of locales and localized descriptions.
482             *
483             * @param descriptionMap the locales and localized descriptions of this journal article
484             */
485            public void setDescriptionMap(Map<Locale, String> descriptionMap);
486    
487            /**
488             * Sets the localized descriptions of this journal article from the map of locales and localized descriptions, and sets the default locale.
489             *
490             * @param descriptionMap the locales and localized descriptions of this journal article
491             * @param defaultLocale the default locale
492             */
493            public void setDescriptionMap(Map<Locale, String> descriptionMap,
494                    Locale defaultLocale);
495    
496            /**
497             * Returns the content of this journal article.
498             *
499             * @return the content of this journal article
500             */
501            @AutoEscape
502            public String getContent();
503    
504            /**
505             * Sets the content of this journal article.
506             *
507             * @param content the content of this journal article
508             */
509            public void setContent(String content);
510    
511            /**
512             * Returns the type of this journal article.
513             *
514             * @return the type of this journal article
515             */
516            @AutoEscape
517            public String getType();
518    
519            /**
520             * Sets the type of this journal article.
521             *
522             * @param type the type of this journal article
523             */
524            public void setType(String type);
525    
526            /**
527             * Returns the structure ID of this journal article.
528             *
529             * @return the structure ID of this journal article
530             */
531            public String getStructureId();
532    
533            /**
534             * Sets the structure ID of this journal article.
535             *
536             * @param structureId the structure ID of this journal article
537             */
538            public void setStructureId(String structureId);
539    
540            /**
541             * Returns the template ID of this journal article.
542             *
543             * @return the template ID of this journal article
544             */
545            public String getTemplateId();
546    
547            /**
548             * Sets the template ID of this journal article.
549             *
550             * @param templateId the template ID of this journal article
551             */
552            public void setTemplateId(String templateId);
553    
554            /**
555             * Returns the layout uuid of this journal article.
556             *
557             * @return the layout uuid of this journal article
558             */
559            @AutoEscape
560            public String getLayoutUuid();
561    
562            /**
563             * Sets the layout uuid of this journal article.
564             *
565             * @param layoutUuid the layout uuid of this journal article
566             */
567            public void setLayoutUuid(String layoutUuid);
568    
569            /**
570             * Returns the display date of this journal article.
571             *
572             * @return the display date of this journal article
573             */
574            public Date getDisplayDate();
575    
576            /**
577             * Sets the display date of this journal article.
578             *
579             * @param displayDate the display date of this journal article
580             */
581            public void setDisplayDate(Date displayDate);
582    
583            /**
584             * Returns the expiration date of this journal article.
585             *
586             * @return the expiration date of this journal article
587             */
588            public Date getExpirationDate();
589    
590            /**
591             * Sets the expiration date of this journal article.
592             *
593             * @param expirationDate the expiration date of this journal article
594             */
595            public void setExpirationDate(Date expirationDate);
596    
597            /**
598             * Returns the review date of this journal article.
599             *
600             * @return the review date of this journal article
601             */
602            public Date getReviewDate();
603    
604            /**
605             * Sets the review date of this journal article.
606             *
607             * @param reviewDate the review date of this journal article
608             */
609            public void setReviewDate(Date reviewDate);
610    
611            /**
612             * Returns the indexable of this journal article.
613             *
614             * @return the indexable of this journal article
615             */
616            public boolean getIndexable();
617    
618            /**
619             * Returns <code>true</code> if this journal article is indexable.
620             *
621             * @return <code>true</code> if this journal article is indexable; <code>false</code> otherwise
622             */
623            public boolean isIndexable();
624    
625            /**
626             * Sets whether this journal article is indexable.
627             *
628             * @param indexable the indexable of this journal article
629             */
630            public void setIndexable(boolean indexable);
631    
632            /**
633             * Returns the small image of this journal article.
634             *
635             * @return the small image of this journal article
636             */
637            public boolean getSmallImage();
638    
639            /**
640             * Returns <code>true</code> if this journal article is small image.
641             *
642             * @return <code>true</code> if this journal article is small image; <code>false</code> otherwise
643             */
644            public boolean isSmallImage();
645    
646            /**
647             * Sets whether this journal article is small image.
648             *
649             * @param smallImage the small image of this journal article
650             */
651            public void setSmallImage(boolean smallImage);
652    
653            /**
654             * Returns the small image ID of this journal article.
655             *
656             * @return the small image ID of this journal article
657             */
658            public long getSmallImageId();
659    
660            /**
661             * Sets the small image ID of this journal article.
662             *
663             * @param smallImageId the small image ID of this journal article
664             */
665            public void setSmallImageId(long smallImageId);
666    
667            /**
668             * Returns the small image u r l of this journal article.
669             *
670             * @return the small image u r l of this journal article
671             */
672            @AutoEscape
673            public String getSmallImageURL();
674    
675            /**
676             * Sets the small image u r l of this journal article.
677             *
678             * @param smallImageURL the small image u r l of this journal article
679             */
680            public void setSmallImageURL(String smallImageURL);
681    
682            /**
683             * Returns the status of this journal article.
684             *
685             * @return the status of this journal article
686             */
687            public int getStatus();
688    
689            /**
690             * Sets the status of this journal article.
691             *
692             * @param status the status of this journal article
693             */
694            public void setStatus(int status);
695    
696            /**
697             * Returns the status by user ID of this journal article.
698             *
699             * @return the status by user ID of this journal article
700             */
701            public long getStatusByUserId();
702    
703            /**
704             * Sets the status by user ID of this journal article.
705             *
706             * @param statusByUserId the status by user ID of this journal article
707             */
708            public void setStatusByUserId(long statusByUserId);
709    
710            /**
711             * Returns the status by user uuid of this journal article.
712             *
713             * @return the status by user uuid of this journal article
714             * @throws SystemException if a system exception occurred
715             */
716            public String getStatusByUserUuid() throws SystemException;
717    
718            /**
719             * Sets the status by user uuid of this journal article.
720             *
721             * @param statusByUserUuid the status by user uuid of this journal article
722             */
723            public void setStatusByUserUuid(String statusByUserUuid);
724    
725            /**
726             * Returns the status by user name of this journal article.
727             *
728             * @return the status by user name of this journal article
729             */
730            @AutoEscape
731            public String getStatusByUserName();
732    
733            /**
734             * Sets the status by user name of this journal article.
735             *
736             * @param statusByUserName the status by user name of this journal article
737             */
738            public void setStatusByUserName(String statusByUserName);
739    
740            /**
741             * Returns the status date of this journal article.
742             *
743             * @return the status date of this journal article
744             */
745            public Date getStatusDate();
746    
747            /**
748             * Sets the status date of this journal article.
749             *
750             * @param statusDate the status date of this journal article
751             */
752            public void setStatusDate(Date statusDate);
753    
754            /**
755             * @deprecated Renamed to {@link #isApproved()}
756             */
757            public boolean getApproved();
758    
759            /**
760             * Returns <code>true</code> if this journal article is approved.
761             *
762             * @return <code>true</code> if this journal article is approved; <code>false</code> otherwise
763             */
764            public boolean isApproved();
765    
766            /**
767             * Returns <code>true</code> if this journal article is denied.
768             *
769             * @return <code>true</code> if this journal article is denied; <code>false</code> otherwise
770             */
771            public boolean isDenied();
772    
773            /**
774             * Returns <code>true</code> if this journal article is a draft.
775             *
776             * @return <code>true</code> if this journal article is a draft; <code>false</code> otherwise
777             */
778            public boolean isDraft();
779    
780            /**
781             * Returns <code>true</code> if this journal article is expired.
782             *
783             * @return <code>true</code> if this journal article is expired; <code>false</code> otherwise
784             */
785            public boolean isExpired();
786    
787            /**
788             * Returns <code>true</code> if this journal article is inactive.
789             *
790             * @return <code>true</code> if this journal article is inactive; <code>false</code> otherwise
791             */
792            public boolean isInactive();
793    
794            /**
795             * Returns <code>true</code> if this journal article is incomplete.
796             *
797             * @return <code>true</code> if this journal article is incomplete; <code>false</code> otherwise
798             */
799            public boolean isIncomplete();
800    
801            /**
802             * Returns <code>true</code> if this journal article is pending.
803             *
804             * @return <code>true</code> if this journal article is pending; <code>false</code> otherwise
805             */
806            public boolean isPending();
807    
808            /**
809             * Returns <code>true</code> if this journal article is scheduled.
810             *
811             * @return <code>true</code> if this journal article is scheduled; <code>false</code> otherwise
812             */
813            public boolean isScheduled();
814    
815            public boolean isNew();
816    
817            public void setNew(boolean n);
818    
819            public boolean isCachedModel();
820    
821            public void setCachedModel(boolean cachedModel);
822    
823            public boolean isEscapedModel();
824    
825            public Serializable getPrimaryKeyObj();
826    
827            public void setPrimaryKeyObj(Serializable primaryKeyObj);
828    
829            public ExpandoBridge getExpandoBridge();
830    
831            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
832    
833            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
834                    throws LocaleException;
835    
836            public Object clone();
837    
838            public int compareTo(JournalArticle journalArticle);
839    
840            public int hashCode();
841    
842            public CacheModel<JournalArticle> toCacheModel();
843    
844            public JournalArticle toEscapedModel();
845    
846            public JournalArticle toUnescapedModel();
847    
848            public String toString();
849    
850            public String toXmlString();
851    }