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