001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets the class name of the model instance this asset entry is polymorphically associated with.
184             *
185             * @return the class name of the model instance this asset entry is polymorphically associated with
186             */
187            public String getClassName();
188    
189            /**
190             * Gets 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             * Gets 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             * Gets 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             * Gets the visible of this asset entry.
234             *
235             * @return the visible of this asset entry
236             */
237            public boolean getVisible();
238    
239            /**
240             * Determines if this asset entry is visible.
241             *
242             * @return <code>true</code> if this asset entry is visible; <code>false</code> otherwise
243             */
244            public boolean isVisible();
245    
246            /**
247             * Sets whether this asset entry is visible.
248             *
249             * @param visible the visible of this asset entry
250             */
251            public void setVisible(boolean visible);
252    
253            /**
254             * Gets the start date of this asset entry.
255             *
256             * @return the start date of this asset entry
257             */
258            public Date getStartDate();
259    
260            /**
261             * Sets the start date of this asset entry.
262             *
263             * @param startDate the start date of this asset entry
264             */
265            public void setStartDate(Date startDate);
266    
267            /**
268             * Gets the end date of this asset entry.
269             *
270             * @return the end date of this asset entry
271             */
272            public Date getEndDate();
273    
274            /**
275             * Sets the end date of this asset entry.
276             *
277             * @param endDate the end date of this asset entry
278             */
279            public void setEndDate(Date endDate);
280    
281            /**
282             * Gets the publish date of this asset entry.
283             *
284             * @return the publish date of this asset entry
285             */
286            public Date getPublishDate();
287    
288            /**
289             * Sets the publish date of this asset entry.
290             *
291             * @param publishDate the publish date of this asset entry
292             */
293            public void setPublishDate(Date publishDate);
294    
295            /**
296             * Gets the expiration date of this asset entry.
297             *
298             * @return the expiration date of this asset entry
299             */
300            public Date getExpirationDate();
301    
302            /**
303             * Sets the expiration date of this asset entry.
304             *
305             * @param expirationDate the expiration date of this asset entry
306             */
307            public void setExpirationDate(Date expirationDate);
308    
309            /**
310             * Gets the mime type of this asset entry.
311             *
312             * @return the mime type of this asset entry
313             */
314            @AutoEscape
315            public String getMimeType();
316    
317            /**
318             * Sets the mime type of this asset entry.
319             *
320             * @param mimeType the mime type of this asset entry
321             */
322            public void setMimeType(String mimeType);
323    
324            /**
325             * Gets the title of this asset entry.
326             *
327             * @return the title of this asset entry
328             */
329            public String getTitle();
330    
331            /**
332             * Gets the localized title of this asset entry. Uses the default language if no localization exists for the requested language.
333             *
334             * @param locale the locale to get the localized title for
335             * @return the localized title of this asset entry
336             */
337            public String getTitle(Locale locale);
338    
339            /**
340             * Gets the localized title of this asset entry, optionally using the default language if no localization exists for the requested language.
341             *
342             * @param locale the local to get the localized title for
343             * @param useDefault whether to use the default language if no localization exists for the requested language
344             * @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.
345             */
346            public String getTitle(Locale locale, boolean useDefault);
347    
348            /**
349             * Gets the localized title of this asset entry. Uses the default language if no localization exists for the requested language.
350             *
351             * @param languageId the id of the language to get the localized title for
352             * @return the localized title of this asset entry
353             */
354            public String getTitle(String languageId);
355    
356            /**
357             * Gets the localized title of this asset entry, optionally using the default language if no localization exists for the requested language.
358             *
359             * @param languageId the id of the language to get the localized title for
360             * @param useDefault whether to use the default language if no localization exists for the requested language
361             * @return the localized title of this asset entry
362             */
363            public String getTitle(String languageId, boolean useDefault);
364    
365            /**
366             * Gets a map of the locales and localized title of this asset entry.
367             *
368             * @return the locales and localized title
369             */
370            public Map<Locale, String> getTitleMap();
371    
372            /**
373             * Sets the title of this asset entry.
374             *
375             * @param title the title of this asset entry
376             */
377            public void setTitle(String title);
378    
379            /**
380             * Sets the localized title of this asset entry.
381             *
382             * @param locale the locale to set the localized title for
383             * @param title the localized title of this asset entry
384             */
385            public void setTitle(Locale locale, String title);
386    
387            /**
388             * Sets the localized titles of this asset entry from the map of locales and localized titles.
389             *
390             * @param titleMap the locales and localized titles of this asset entry
391             */
392            public void setTitleMap(Map<Locale, String> titleMap);
393    
394            /**
395             * Gets the description of this asset entry.
396             *
397             * @return the description of this asset entry
398             */
399            @AutoEscape
400            public String getDescription();
401    
402            /**
403             * Sets the description of this asset entry.
404             *
405             * @param description the description of this asset entry
406             */
407            public void setDescription(String description);
408    
409            /**
410             * Gets the summary of this asset entry.
411             *
412             * @return the summary of this asset entry
413             */
414            @AutoEscape
415            public String getSummary();
416    
417            /**
418             * Sets the summary of this asset entry.
419             *
420             * @param summary the summary of this asset entry
421             */
422            public void setSummary(String summary);
423    
424            /**
425             * Gets the url of this asset entry.
426             *
427             * @return the url of this asset entry
428             */
429            @AutoEscape
430            public String getUrl();
431    
432            /**
433             * Sets the url of this asset entry.
434             *
435             * @param url the url of this asset entry
436             */
437            public void setUrl(String url);
438    
439            /**
440             * Gets the height of this asset entry.
441             *
442             * @return the height of this asset entry
443             */
444            public int getHeight();
445    
446            /**
447             * Sets the height of this asset entry.
448             *
449             * @param height the height of this asset entry
450             */
451            public void setHeight(int height);
452    
453            /**
454             * Gets the width of this asset entry.
455             *
456             * @return the width of this asset entry
457             */
458            public int getWidth();
459    
460            /**
461             * Sets the width of this asset entry.
462             *
463             * @param width the width of this asset entry
464             */
465            public void setWidth(int width);
466    
467            /**
468             * Gets the priority of this asset entry.
469             *
470             * @return the priority of this asset entry
471             */
472            public double getPriority();
473    
474            /**
475             * Sets the priority of this asset entry.
476             *
477             * @param priority the priority of this asset entry
478             */
479            public void setPriority(double priority);
480    
481            /**
482             * Gets the view count of this asset entry.
483             *
484             * @return the view count of this asset entry
485             */
486            public int getViewCount();
487    
488            /**
489             * Sets the view count of this asset entry.
490             *
491             * @param viewCount the view count of this asset entry
492             */
493            public void setViewCount(int viewCount);
494    
495            public boolean isNew();
496    
497            public void setNew(boolean n);
498    
499            public boolean isCachedModel();
500    
501            public void setCachedModel(boolean cachedModel);
502    
503            public boolean isEscapedModel();
504    
505            public void setEscapedModel(boolean escapedModel);
506    
507            public Serializable getPrimaryKeyObj();
508    
509            public void setPrimaryKeyObj(Serializable primaryKeyObj);
510    
511            public ExpandoBridge getExpandoBridge();
512    
513            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
514    
515            public Object clone();
516    
517            public int compareTo(AssetEntry assetEntry);
518    
519            public int hashCode();
520    
521            public CacheModel<AssetEntry> toCacheModel();
522    
523            public AssetEntry toEscapedModel();
524    
525            public String toString();
526    
527            public String toXmlString();
528    }