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