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