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