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