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