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