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.LocaleException;
018    import com.liferay.portal.kernel.bean.AutoEscape;
019    import com.liferay.portal.kernel.exception.SystemException;
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.model.StagedModel;
024    import com.liferay.portal.service.ServiceContext;
025    
026    import com.liferay.portlet.expando.model.ExpandoBridge;
027    
028    import java.io.Serializable;
029    
030    import java.util.Date;
031    import java.util.Locale;
032    import java.util.Map;
033    
034    /**
035     * The base model interface for the AssetCategory service. Represents a row in the "AssetCategory" database table, with each column mapped to a property of this class.
036     *
037     * <p>
038     * This interface and its corresponding implementation {@link com.liferay.portlet.asset.model.impl.AssetCategoryModelImpl} 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.AssetCategoryImpl}.
039     * </p>
040     *
041     * @author Brian Wing Shun Chan
042     * @see AssetCategory
043     * @see com.liferay.portlet.asset.model.impl.AssetCategoryImpl
044     * @see com.liferay.portlet.asset.model.impl.AssetCategoryModelImpl
045     * @generated
046     */
047    public interface AssetCategoryModel extends BaseModel<AssetCategory>,
048            GroupedModel, StagedModel {
049            /*
050             * NOTE FOR DEVELOPERS:
051             *
052             * Never modify or reference this interface directly. All methods that expect a asset category model instance should use the {@link AssetCategory} interface instead.
053             */
054    
055            /**
056             * Returns the primary key of this asset category.
057             *
058             * @return the primary key of this asset category
059             */
060            public long getPrimaryKey();
061    
062            /**
063             * Sets the primary key of this asset category.
064             *
065             * @param primaryKey the primary key of this asset category
066             */
067            public void setPrimaryKey(long primaryKey);
068    
069            /**
070             * Returns the uuid of this asset category.
071             *
072             * @return the uuid of this asset category
073             */
074            @AutoEscape
075            public String getUuid();
076    
077            /**
078             * Sets the uuid of this asset category.
079             *
080             * @param uuid the uuid of this asset category
081             */
082            public void setUuid(String uuid);
083    
084            /**
085             * Returns the category ID of this asset category.
086             *
087             * @return the category ID of this asset category
088             */
089            public long getCategoryId();
090    
091            /**
092             * Sets the category ID of this asset category.
093             *
094             * @param categoryId the category ID of this asset category
095             */
096            public void setCategoryId(long categoryId);
097    
098            /**
099             * Returns the group ID of this asset category.
100             *
101             * @return the group ID of this asset category
102             */
103            public long getGroupId();
104    
105            /**
106             * Sets the group ID of this asset category.
107             *
108             * @param groupId the group ID of this asset category
109             */
110            public void setGroupId(long groupId);
111    
112            /**
113             * Returns the company ID of this asset category.
114             *
115             * @return the company ID of this asset category
116             */
117            public long getCompanyId();
118    
119            /**
120             * Sets the company ID of this asset category.
121             *
122             * @param companyId the company ID of this asset category
123             */
124            public void setCompanyId(long companyId);
125    
126            /**
127             * Returns the user ID of this asset category.
128             *
129             * @return the user ID of this asset category
130             */
131            public long getUserId();
132    
133            /**
134             * Sets the user ID of this asset category.
135             *
136             * @param userId the user ID of this asset category
137             */
138            public void setUserId(long userId);
139    
140            /**
141             * Returns the user uuid of this asset category.
142             *
143             * @return the user uuid of this asset category
144             * @throws SystemException if a system exception occurred
145             */
146            public String getUserUuid() throws SystemException;
147    
148            /**
149             * Sets the user uuid of this asset category.
150             *
151             * @param userUuid the user uuid of this asset category
152             */
153            public void setUserUuid(String userUuid);
154    
155            /**
156             * Returns the user name of this asset category.
157             *
158             * @return the user name of this asset category
159             */
160            @AutoEscape
161            public String getUserName();
162    
163            /**
164             * Sets the user name of this asset category.
165             *
166             * @param userName the user name of this asset category
167             */
168            public void setUserName(String userName);
169    
170            /**
171             * Returns the create date of this asset category.
172             *
173             * @return the create date of this asset category
174             */
175            public Date getCreateDate();
176    
177            /**
178             * Sets the create date of this asset category.
179             *
180             * @param createDate the create date of this asset category
181             */
182            public void setCreateDate(Date createDate);
183    
184            /**
185             * Returns the modified date of this asset category.
186             *
187             * @return the modified date of this asset category
188             */
189            public Date getModifiedDate();
190    
191            /**
192             * Sets the modified date of this asset category.
193             *
194             * @param modifiedDate the modified date of this asset category
195             */
196            public void setModifiedDate(Date modifiedDate);
197    
198            /**
199             * Returns the parent category ID of this asset category.
200             *
201             * @return the parent category ID of this asset category
202             */
203            public long getParentCategoryId();
204    
205            /**
206             * Sets the parent category ID of this asset category.
207             *
208             * @param parentCategoryId the parent category ID of this asset category
209             */
210            public void setParentCategoryId(long parentCategoryId);
211    
212            /**
213             * Returns the left category ID of this asset category.
214             *
215             * @return the left category ID of this asset category
216             */
217            public long getLeftCategoryId();
218    
219            /**
220             * Sets the left category ID of this asset category.
221             *
222             * @param leftCategoryId the left category ID of this asset category
223             */
224            public void setLeftCategoryId(long leftCategoryId);
225    
226            /**
227             * Returns the right category ID of this asset category.
228             *
229             * @return the right category ID of this asset category
230             */
231            public long getRightCategoryId();
232    
233            /**
234             * Sets the right category ID of this asset category.
235             *
236             * @param rightCategoryId the right category ID of this asset category
237             */
238            public void setRightCategoryId(long rightCategoryId);
239    
240            /**
241             * Returns the name of this asset category.
242             *
243             * @return the name of this asset category
244             */
245            @AutoEscape
246            public String getName();
247    
248            /**
249             * Sets the name of this asset category.
250             *
251             * @param name the name of this asset category
252             */
253            public void setName(String name);
254    
255            /**
256             * Returns the title of this asset category.
257             *
258             * @return the title of this asset category
259             */
260            public String getTitle();
261    
262            /**
263             * Returns the localized title of this asset category in the language. Uses the default language if no localization exists for the requested language.
264             *
265             * @param locale the locale of the language
266             * @return the localized title of this asset category
267             */
268            @AutoEscape
269            public String getTitle(Locale locale);
270    
271            /**
272             * Returns the localized title of this asset category in the language, optionally using the default language if no localization exists for the requested language.
273             *
274             * @param locale the local of the language
275             * @param useDefault whether to use the default language if no localization exists for the requested language
276             * @return the localized title of this asset category. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
277             */
278            @AutoEscape
279            public String getTitle(Locale locale, boolean useDefault);
280    
281            /**
282             * Returns the localized title of this asset category in the language. Uses the default language if no localization exists for the requested language.
283             *
284             * @param languageId the ID of the language
285             * @return the localized title of this asset category
286             */
287            @AutoEscape
288            public String getTitle(String languageId);
289    
290            /**
291             * Returns the localized title of this asset category in the language, optionally using the default language if no localization exists for the requested language.
292             *
293             * @param languageId the ID of the language
294             * @param useDefault whether to use the default language if no localization exists for the requested language
295             * @return the localized title of this asset category
296             */
297            @AutoEscape
298            public String getTitle(String languageId, boolean useDefault);
299    
300            @AutoEscape
301            public String getTitleCurrentLanguageId();
302    
303            @AutoEscape
304            public String getTitleCurrentValue();
305    
306            /**
307             * Returns a map of the locales and localized titles of this asset category.
308             *
309             * @return the locales and localized titles of this asset category
310             */
311            public Map<Locale, String> getTitleMap();
312    
313            /**
314             * Sets the title of this asset category.
315             *
316             * @param title the title of this asset category
317             */
318            public void setTitle(String title);
319    
320            /**
321             * Sets the localized title of this asset category in the language.
322             *
323             * @param title the localized title of this asset category
324             * @param locale the locale of the language
325             */
326            public void setTitle(String title, Locale locale);
327    
328            /**
329             * Sets the localized title of this asset category in the language, and sets the default locale.
330             *
331             * @param title the localized title of this asset category
332             * @param locale the locale of the language
333             * @param defaultLocale the default locale
334             */
335            public void setTitle(String title, Locale locale, Locale defaultLocale);
336    
337            public void setTitleCurrentLanguageId(String languageId);
338    
339            /**
340             * Sets the localized titles of this asset category from the map of locales and localized titles.
341             *
342             * @param titleMap the locales and localized titles of this asset category
343             */
344            public void setTitleMap(Map<Locale, String> titleMap);
345    
346            /**
347             * Sets the localized titles of this asset category from the map of locales and localized titles, and sets the default locale.
348             *
349             * @param titleMap the locales and localized titles of this asset category
350             * @param defaultLocale the default locale
351             */
352            public void setTitleMap(Map<Locale, String> titleMap, Locale defaultLocale);
353    
354            /**
355             * Returns the description of this asset category.
356             *
357             * @return the description of this asset category
358             */
359            public String getDescription();
360    
361            /**
362             * Returns the localized description of this asset category in the language. Uses the default language if no localization exists for the requested language.
363             *
364             * @param locale the locale of the language
365             * @return the localized description of this asset category
366             */
367            @AutoEscape
368            public String getDescription(Locale locale);
369    
370            /**
371             * Returns the localized description of this asset category in the language, optionally using the default language if no localization exists for the requested language.
372             *
373             * @param locale the local of the language
374             * @param useDefault whether to use the default language if no localization exists for the requested language
375             * @return the localized description of this asset category. If <code>useDefault</code> is <code>false</code> and no localization exists for the requested language, an empty string will be returned.
376             */
377            @AutoEscape
378            public String getDescription(Locale locale, boolean useDefault);
379    
380            /**
381             * Returns the localized description of this asset category in the language. Uses the default language if no localization exists for the requested language.
382             *
383             * @param languageId the ID of the language
384             * @return the localized description of this asset category
385             */
386            @AutoEscape
387            public String getDescription(String languageId);
388    
389            /**
390             * Returns the localized description of this asset category in the language, optionally using the default language if no localization exists for the requested language.
391             *
392             * @param languageId the ID of the language
393             * @param useDefault whether to use the default language if no localization exists for the requested language
394             * @return the localized description of this asset category
395             */
396            @AutoEscape
397            public String getDescription(String languageId, boolean useDefault);
398    
399            @AutoEscape
400            public String getDescriptionCurrentLanguageId();
401    
402            @AutoEscape
403            public String getDescriptionCurrentValue();
404    
405            /**
406             * Returns a map of the locales and localized descriptions of this asset category.
407             *
408             * @return the locales and localized descriptions of this asset category
409             */
410            public Map<Locale, String> getDescriptionMap();
411    
412            /**
413             * Sets the description of this asset category.
414             *
415             * @param description the description of this asset category
416             */
417            public void setDescription(String description);
418    
419            /**
420             * Sets the localized description of this asset category in the language.
421             *
422             * @param description the localized description of this asset category
423             * @param locale the locale of the language
424             */
425            public void setDescription(String description, Locale locale);
426    
427            /**
428             * Sets the localized description of this asset category in the language, and sets the default locale.
429             *
430             * @param description the localized description of this asset category
431             * @param locale the locale of the language
432             * @param defaultLocale the default locale
433             */
434            public void setDescription(String description, Locale locale,
435                    Locale defaultLocale);
436    
437            public void setDescriptionCurrentLanguageId(String languageId);
438    
439            /**
440             * Sets the localized descriptions of this asset category from the map of locales and localized descriptions.
441             *
442             * @param descriptionMap the locales and localized descriptions of this asset category
443             */
444            public void setDescriptionMap(Map<Locale, String> descriptionMap);
445    
446            /**
447             * Sets the localized descriptions of this asset category from the map of locales and localized descriptions, and sets the default locale.
448             *
449             * @param descriptionMap the locales and localized descriptions of this asset category
450             * @param defaultLocale the default locale
451             */
452            public void setDescriptionMap(Map<Locale, String> descriptionMap,
453                    Locale defaultLocale);
454    
455            /**
456             * Returns the vocabulary ID of this asset category.
457             *
458             * @return the vocabulary ID of this asset category
459             */
460            public long getVocabularyId();
461    
462            /**
463             * Sets the vocabulary ID of this asset category.
464             *
465             * @param vocabularyId the vocabulary ID of this asset category
466             */
467            public void setVocabularyId(long vocabularyId);
468    
469            public boolean isNew();
470    
471            public void setNew(boolean n);
472    
473            public boolean isCachedModel();
474    
475            public void setCachedModel(boolean cachedModel);
476    
477            public boolean isEscapedModel();
478    
479            public Serializable getPrimaryKeyObj();
480    
481            public void setPrimaryKeyObj(Serializable primaryKeyObj);
482    
483            public ExpandoBridge getExpandoBridge();
484    
485            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
486    
487            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
488                    throws LocaleException;
489    
490            public Object clone();
491    
492            public int compareTo(AssetCategory assetCategory);
493    
494            public int hashCode();
495    
496            public CacheModel<AssetCategory> toCacheModel();
497    
498            public AssetCategory toEscapedModel();
499    
500            public AssetCategory toUnescapedModel();
501    
502            public String toString();
503    
504            public String toXmlString();
505    }