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