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.documentlibrary.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 DLFileEntryType service. Represents a row in the "DLFileEntryType" 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.documentlibrary.model.impl.DLFileEntryTypeModelImpl} 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.documentlibrary.model.impl.DLFileEntryTypeImpl}.
038     * </p>
039     *
040     * @author Brian Wing Shun Chan
041     * @see DLFileEntryType
042     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileEntryTypeImpl
043     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileEntryTypeModelImpl
044     * @generated
045     */
046    public interface DLFileEntryTypeModel extends BaseModel<DLFileEntryType>,
047            StagedGroupedModel {
048            /*
049             * NOTE FOR DEVELOPERS:
050             *
051             * Never modify or reference this interface directly. All methods that expect a document library file entry type model instance should use the {@link DLFileEntryType} interface instead.
052             */
053    
054            /**
055             * Returns the primary key of this document library file entry type.
056             *
057             * @return the primary key of this document library file entry type
058             */
059            public long getPrimaryKey();
060    
061            /**
062             * Sets the primary key of this document library file entry type.
063             *
064             * @param primaryKey the primary key of this document library file entry type
065             */
066            public void setPrimaryKey(long primaryKey);
067    
068            /**
069             * Returns the uuid of this document library file entry type.
070             *
071             * @return the uuid of this document library file entry type
072             */
073            @AutoEscape
074            @Override
075            public String getUuid();
076    
077            /**
078             * Sets the uuid of this document library file entry type.
079             *
080             * @param uuid the uuid of this document library file entry type
081             */
082            @Override
083            public void setUuid(String uuid);
084    
085            /**
086             * Returns the file entry type ID of this document library file entry type.
087             *
088             * @return the file entry type ID of this document library file entry type
089             */
090            public long getFileEntryTypeId();
091    
092            /**
093             * Sets the file entry type ID of this document library file entry type.
094             *
095             * @param fileEntryTypeId the file entry type ID of this document library file entry type
096             */
097            public void setFileEntryTypeId(long fileEntryTypeId);
098    
099            /**
100             * Returns the group ID of this document library file entry type.
101             *
102             * @return the group ID of this document library file entry type
103             */
104            @Override
105            public long getGroupId();
106    
107            /**
108             * Sets the group ID of this document library file entry type.
109             *
110             * @param groupId the group ID of this document library file entry type
111             */
112            @Override
113            public void setGroupId(long groupId);
114    
115            /**
116             * Returns the company ID of this document library file entry type.
117             *
118             * @return the company ID of this document library file entry type
119             */
120            @Override
121            public long getCompanyId();
122    
123            /**
124             * Sets the company ID of this document library file entry type.
125             *
126             * @param companyId the company ID of this document library file entry type
127             */
128            @Override
129            public void setCompanyId(long companyId);
130    
131            /**
132             * Returns the user ID of this document library file entry type.
133             *
134             * @return the user ID of this document library file entry type
135             */
136            @Override
137            public long getUserId();
138    
139            /**
140             * Sets the user ID of this document library file entry type.
141             *
142             * @param userId the user ID of this document library file entry type
143             */
144            @Override
145            public void setUserId(long userId);
146    
147            /**
148             * Returns the user uuid of this document library file entry type.
149             *
150             * @return the user uuid of this document library file entry type
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 document library file entry type.
158             *
159             * @param userUuid the user uuid of this document library file entry type
160             */
161            @Override
162            public void setUserUuid(String userUuid);
163    
164            /**
165             * Returns the user name of this document library file entry type.
166             *
167             * @return the user name of this document library file entry type
168             */
169            @AutoEscape
170            @Override
171            public String getUserName();
172    
173            /**
174             * Sets the user name of this document library file entry type.
175             *
176             * @param userName the user name of this document library file entry type
177             */
178            @Override
179            public void setUserName(String userName);
180    
181            /**
182             * Returns the create date of this document library file entry type.
183             *
184             * @return the create date of this document library file entry type
185             */
186            @Override
187            public Date getCreateDate();
188    
189            /**
190             * Sets the create date of this document library file entry type.
191             *
192             * @param createDate the create date of this document library file entry type
193             */
194            @Override
195            public void setCreateDate(Date createDate);
196    
197            /**
198             * Returns the modified date of this document library file entry type.
199             *
200             * @return the modified date of this document library file entry type
201             */
202            @Override
203            public Date getModifiedDate();
204    
205            /**
206             * Sets the modified date of this document library file entry type.
207             *
208             * @param modifiedDate the modified date of this document library file entry type
209             */
210            @Override
211            public void setModifiedDate(Date modifiedDate);
212    
213            /**
214             * Returns the file entry type key of this document library file entry type.
215             *
216             * @return the file entry type key of this document library file entry type
217             */
218            @AutoEscape
219            public String getFileEntryTypeKey();
220    
221            /**
222             * Sets the file entry type key of this document library file entry type.
223             *
224             * @param fileEntryTypeKey the file entry type key of this document library file entry type
225             */
226            public void setFileEntryTypeKey(String fileEntryTypeKey);
227    
228            /**
229             * Returns the name of this document library file entry type.
230             *
231             * @return the name of this document library file entry type
232             */
233            public String getName();
234    
235            /**
236             * Returns the localized name of this document library file entry type 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 name of this document library file entry type
240             */
241            @AutoEscape
242            public String getName(Locale locale);
243    
244            /**
245             * Returns the localized name of this document library file entry type 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 name of this document library file entry type. 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 getName(Locale locale, boolean useDefault);
253    
254            /**
255             * Returns the localized name of this document library file entry type 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 name of this document library file entry type
259             */
260            @AutoEscape
261            public String getName(String languageId);
262    
263            /**
264             * Returns the localized name of this document library file entry type 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 name of this document library file entry type
269             */
270            @AutoEscape
271            public String getName(String languageId, boolean useDefault);
272    
273            @AutoEscape
274            public String getNameCurrentLanguageId();
275    
276            @AutoEscape
277            public String getNameCurrentValue();
278    
279            /**
280             * Returns a map of the locales and localized names of this document library file entry type.
281             *
282             * @return the locales and localized names of this document library file entry type
283             */
284            public Map<Locale, String> getNameMap();
285    
286            /**
287             * Sets the name of this document library file entry type.
288             *
289             * @param name the name of this document library file entry type
290             */
291            public void setName(String name);
292    
293            /**
294             * Sets the localized name of this document library file entry type in the language.
295             *
296             * @param name the localized name of this document library file entry type
297             * @param locale the locale of the language
298             */
299            public void setName(String name, Locale locale);
300    
301            /**
302             * Sets the localized name of this document library file entry type in the language, and sets the default locale.
303             *
304             * @param name the localized name of this document library file entry type
305             * @param locale the locale of the language
306             * @param defaultLocale the default locale
307             */
308            public void setName(String name, Locale locale, Locale defaultLocale);
309    
310            public void setNameCurrentLanguageId(String languageId);
311    
312            /**
313             * Sets the localized names of this document library file entry type from the map of locales and localized names.
314             *
315             * @param nameMap the locales and localized names of this document library file entry type
316             */
317            public void setNameMap(Map<Locale, String> nameMap);
318    
319            /**
320             * Sets the localized names of this document library file entry type from the map of locales and localized names, and sets the default locale.
321             *
322             * @param nameMap the locales and localized names of this document library file entry type
323             * @param defaultLocale the default locale
324             */
325            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
326    
327            /**
328             * Returns the description of this document library file entry type.
329             *
330             * @return the description of this document library file entry type
331             */
332            public String getDescription();
333    
334            /**
335             * Returns the localized description of this document library file entry type 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 document library file entry type
339             */
340            @AutoEscape
341            public String getDescription(Locale locale);
342    
343            /**
344             * Returns the localized description of this document library file entry type 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 document library file entry type. 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 document library file entry type 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 document library file entry type
358             */
359            @AutoEscape
360            public String getDescription(String languageId);
361    
362            /**
363             * Returns the localized description of this document library file entry type 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 document library file entry type
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 document library file entry type.
380             *
381             * @return the locales and localized descriptions of this document library file entry type
382             */
383            public Map<Locale, String> getDescriptionMap();
384    
385            /**
386             * Sets the description of this document library file entry type.
387             *
388             * @param description the description of this document library file entry type
389             */
390            public void setDescription(String description);
391    
392            /**
393             * Sets the localized description of this document library file entry type in the language.
394             *
395             * @param description the localized description of this document library file entry type
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 document library file entry type in the language, and sets the default locale.
402             *
403             * @param description the localized description of this document library file entry type
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 document library file entry type from the map of locales and localized descriptions.
414             *
415             * @param descriptionMap the locales and localized descriptions of this document library file entry type
416             */
417            public void setDescriptionMap(Map<Locale, String> descriptionMap);
418    
419            /**
420             * Sets the localized descriptions of this document library file entry type from the map of locales and localized descriptions, and sets the default locale.
421             *
422             * @param descriptionMap the locales and localized descriptions of this document library file entry type
423             * @param defaultLocale the default locale
424             */
425            public void setDescriptionMap(Map<Locale, String> descriptionMap,
426                    Locale defaultLocale);
427    
428            @Override
429            public boolean isNew();
430    
431            @Override
432            public void setNew(boolean n);
433    
434            @Override
435            public boolean isCachedModel();
436    
437            @Override
438            public void setCachedModel(boolean cachedModel);
439    
440            @Override
441            public boolean isEscapedModel();
442    
443            @Override
444            public Serializable getPrimaryKeyObj();
445    
446            @Override
447            public void setPrimaryKeyObj(Serializable primaryKeyObj);
448    
449            @Override
450            public ExpandoBridge getExpandoBridge();
451    
452            @Override
453            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
454    
455            @Override
456            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
457    
458            @Override
459            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
460    
461            public String[] getAvailableLanguageIds();
462    
463            public String getDefaultLanguageId();
464    
465            public void prepareLocalizedFieldsForImport() throws LocaleException;
466    
467            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
468                    throws LocaleException;
469    
470            @Override
471            public Object clone();
472    
473            @Override
474            public int compareTo(DLFileEntryType dlFileEntryType);
475    
476            @Override
477            public int hashCode();
478    
479            @Override
480            public CacheModel<DLFileEntryType> toCacheModel();
481    
482            @Override
483            public DLFileEntryType toEscapedModel();
484    
485            @Override
486            public DLFileEntryType toUnescapedModel();
487    
488            @Override
489            public String toString();
490    
491            @Override
492            public String toXmlString();
493    }