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