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