001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets 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             * Gets the title of this asset vocabulary.
213             *
214             * @return the title of this asset vocabulary
215             */
216            public String getTitle();
217    
218            /**
219             * Gets the localized title of this asset vocabulary. Uses the default language if no localization exists for the requested language.
220             *
221             * @param locale the locale to get the localized title for
222             * @return the localized title of this asset vocabulary
223             */
224            public String getTitle(Locale locale);
225    
226            /**
227             * Gets the localized title of this asset vocabulary, optionally using the default language if no localization exists for the requested language.
228             *
229             * @param locale the local to get the localized title for
230             * @param useDefault whether to use the default language if no localization exists for the requested language
231             * @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.
232             */
233            public String getTitle(Locale locale, boolean useDefault);
234    
235            /**
236             * Gets the localized title of this asset vocabulary. Uses the default language if no localization exists for the requested language.
237             *
238             * @param languageId the id of the language to get the localized title for
239             * @return the localized title of this asset vocabulary
240             */
241            public String getTitle(String languageId);
242    
243            /**
244             * Gets the localized title of this asset vocabulary, optionally using the default language if no localization exists for the requested language.
245             *
246             * @param languageId the id of the language to get the localized title for
247             * @param useDefault whether to use the default language if no localization exists for the requested language
248             * @return the localized title of this asset vocabulary
249             */
250            public String getTitle(String languageId, boolean useDefault);
251    
252            /**
253             * Gets a map of the locales and localized title of this asset vocabulary.
254             *
255             * @return the locales and localized title
256             */
257            public Map<Locale, String> getTitleMap();
258    
259            /**
260             * Sets the title of this asset vocabulary.
261             *
262             * @param title the title of this asset vocabulary
263             */
264            public void setTitle(String title);
265    
266            /**
267             * Sets the localized title of this asset vocabulary.
268             *
269             * @param locale the locale to set the localized title for
270             * @param title the localized title of this asset vocabulary
271             */
272            public void setTitle(Locale locale, String title);
273    
274            /**
275             * Sets the localized titles of this asset vocabulary from the map of locales and localized titles.
276             *
277             * @param titleMap the locales and localized titles of this asset vocabulary
278             */
279            public void setTitleMap(Map<Locale, String> titleMap);
280    
281            /**
282             * Gets the description of this asset vocabulary.
283             *
284             * @return the description of this asset vocabulary
285             */
286            public String getDescription();
287    
288            /**
289             * Gets the localized description of this asset vocabulary. Uses the default language if no localization exists for the requested language.
290             *
291             * @param locale the locale to get the localized description for
292             * @return the localized description of this asset vocabulary
293             */
294            public String getDescription(Locale locale);
295    
296            /**
297             * Gets the localized description of this asset vocabulary, optionally using the default language if no localization exists for the requested language.
298             *
299             * @param locale the local to get the localized description for
300             * @param useDefault whether to use the default language if no localization exists for the requested language
301             * @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.
302             */
303            public String getDescription(Locale locale, boolean useDefault);
304    
305            /**
306             * Gets the localized description of this asset vocabulary. Uses the default language if no localization exists for the requested language.
307             *
308             * @param languageId the id of the language to get the localized description for
309             * @return the localized description of this asset vocabulary
310             */
311            public String getDescription(String languageId);
312    
313            /**
314             * Gets the localized description of this asset vocabulary, optionally using the default language if no localization exists for the requested language.
315             *
316             * @param languageId the id of the language to get the localized description for
317             * @param useDefault whether to use the default language if no localization exists for the requested language
318             * @return the localized description of this asset vocabulary
319             */
320            public String getDescription(String languageId, boolean useDefault);
321    
322            /**
323             * Gets a map of the locales and localized description of this asset vocabulary.
324             *
325             * @return the locales and localized description
326             */
327            public Map<Locale, String> getDescriptionMap();
328    
329            /**
330             * Sets the description of this asset vocabulary.
331             *
332             * @param description the description of this asset vocabulary
333             */
334            public void setDescription(String description);
335    
336            /**
337             * Sets the localized description of this asset vocabulary.
338             *
339             * @param locale the locale to set the localized description for
340             * @param description the localized description of this asset vocabulary
341             */
342            public void setDescription(Locale locale, String description);
343    
344            /**
345             * Sets the localized descriptions of this asset vocabulary from the map of locales and localized descriptions.
346             *
347             * @param descriptionMap the locales and localized descriptions of this asset vocabulary
348             */
349            public void setDescriptionMap(Map<Locale, String> descriptionMap);
350    
351            /**
352             * Gets the settings of this asset vocabulary.
353             *
354             * @return the settings of this asset vocabulary
355             */
356            @AutoEscape
357            public String getSettings();
358    
359            /**
360             * Sets the settings of this asset vocabulary.
361             *
362             * @param settings the settings of this asset vocabulary
363             */
364            public void setSettings(String settings);
365    
366            public boolean isNew();
367    
368            public void setNew(boolean n);
369    
370            public boolean isCachedModel();
371    
372            public void setCachedModel(boolean cachedModel);
373    
374            public boolean isEscapedModel();
375    
376            public void setEscapedModel(boolean escapedModel);
377    
378            public Serializable getPrimaryKeyObj();
379    
380            public void setPrimaryKeyObj(Serializable primaryKeyObj);
381    
382            public ExpandoBridge getExpandoBridge();
383    
384            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
385    
386            public Object clone();
387    
388            public int compareTo(AssetVocabulary assetVocabulary);
389    
390            public int hashCode();
391    
392            public CacheModel<AssetVocabulary> toCacheModel();
393    
394            public AssetVocabulary toEscapedModel();
395    
396            public String toString();
397    
398            public String toXmlString();
399    }