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