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