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