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