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.dynamicdatamapping.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.AttachedModel;
022    import com.liferay.portal.model.BaseModel;
023    import com.liferay.portal.model.CacheModel;
024    import com.liferay.portal.model.LocalizedModel;
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 DDMTemplate service. Represents a row in the "DDMTemplate" 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.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}.
041     * </p>
042     *
043     * @author Brian Wing Shun Chan
044     * @see DDMTemplate
045     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateImpl
046     * @see com.liferay.portlet.dynamicdatamapping.model.impl.DDMTemplateModelImpl
047     * @generated
048     */
049    @ProviderType
050    public interface DDMTemplateModel extends AttachedModel, BaseModel<DDMTemplate>,
051            LocalizedModel, StagedGroupedModel {
052            /*
053             * NOTE FOR DEVELOPERS:
054             *
055             * 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.
056             */
057    
058            /**
059             * Returns the primary key of this d d m template.
060             *
061             * @return the primary key of this d d m template
062             */
063            public long getPrimaryKey();
064    
065            /**
066             * Sets the primary key of this d d m template.
067             *
068             * @param primaryKey the primary key of this d d m template
069             */
070            public void setPrimaryKey(long primaryKey);
071    
072            /**
073             * Returns the uuid of this d d m template.
074             *
075             * @return the uuid of this d d m template
076             */
077            @AutoEscape
078            @Override
079            public String getUuid();
080    
081            /**
082             * Sets the uuid of this d d m template.
083             *
084             * @param uuid the uuid of this d d m template
085             */
086            @Override
087            public void setUuid(String uuid);
088    
089            /**
090             * Returns the template ID of this d d m template.
091             *
092             * @return the template ID of this d d m template
093             */
094            public long getTemplateId();
095    
096            /**
097             * Sets the template ID of this d d m template.
098             *
099             * @param templateId the template ID of this d d m template
100             */
101            public void setTemplateId(long templateId);
102    
103            /**
104             * Returns the group ID of this d d m template.
105             *
106             * @return the group ID of this d d m template
107             */
108            @Override
109            public long getGroupId();
110    
111            /**
112             * Sets the group ID of this d d m template.
113             *
114             * @param groupId the group ID of this d d m template
115             */
116            @Override
117            public void setGroupId(long groupId);
118    
119            /**
120             * Returns the company ID of this d d m template.
121             *
122             * @return the company ID of this d d m template
123             */
124            @Override
125            public long getCompanyId();
126    
127            /**
128             * Sets the company ID of this d d m template.
129             *
130             * @param companyId the company ID of this d d m template
131             */
132            @Override
133            public void setCompanyId(long companyId);
134    
135            /**
136             * Returns the user ID of this d d m template.
137             *
138             * @return the user ID of this d d m template
139             */
140            @Override
141            public long getUserId();
142    
143            /**
144             * Sets the user ID of this d d m template.
145             *
146             * @param userId the user ID of this d d m template
147             */
148            @Override
149            public void setUserId(long userId);
150    
151            /**
152             * Returns the user uuid of this d d m template.
153             *
154             * @return the user uuid of this d d m template
155             */
156            @Override
157            public String getUserUuid();
158    
159            /**
160             * Sets the user uuid of this d d m template.
161             *
162             * @param userUuid the user uuid of this d d m template
163             */
164            @Override
165            public void setUserUuid(String userUuid);
166    
167            /**
168             * Returns the user name of this d d m template.
169             *
170             * @return the user name of this d d m template
171             */
172            @AutoEscape
173            @Override
174            public String getUserName();
175    
176            /**
177             * Sets the user name of this d d m template.
178             *
179             * @param userName the user name of this d d m template
180             */
181            @Override
182            public void setUserName(String userName);
183    
184            /**
185             * Returns the create date of this d d m template.
186             *
187             * @return the create date of this d d m template
188             */
189            @Override
190            public Date getCreateDate();
191    
192            /**
193             * Sets the create date of this d d m template.
194             *
195             * @param createDate the create date of this d d m template
196             */
197            @Override
198            public void setCreateDate(Date createDate);
199    
200            /**
201             * Returns the modified date of this d d m template.
202             *
203             * @return the modified date of this d d m template
204             */
205            @Override
206            public Date getModifiedDate();
207    
208            /**
209             * Sets the modified date of this d d m template.
210             *
211             * @param modifiedDate the modified date of this d d m template
212             */
213            @Override
214            public void setModifiedDate(Date modifiedDate);
215    
216            /**
217             * Returns the fully qualified class name of this d d m template.
218             *
219             * @return the fully qualified class name of this d d m template
220             */
221            @Override
222            public String getClassName();
223    
224            public void setClassName(String className);
225    
226            /**
227             * Returns the class name ID of this d d m template.
228             *
229             * @return the class name ID of this d d m template
230             */
231            @Override
232            public long getClassNameId();
233    
234            /**
235             * Sets the class name ID of this d d m template.
236             *
237             * @param classNameId the class name ID of this d d m template
238             */
239            @Override
240            public void setClassNameId(long classNameId);
241    
242            /**
243             * Returns the class p k of this d d m template.
244             *
245             * @return the class p k of this d d m template
246             */
247            @Override
248            public long getClassPK();
249    
250            /**
251             * Sets the class p k of this d d m template.
252             *
253             * @param classPK the class p k of this d d m template
254             */
255            @Override
256            public void setClassPK(long classPK);
257    
258            /**
259             * Returns the template key of this d d m template.
260             *
261             * @return the template key of this d d m template
262             */
263            public String getTemplateKey();
264    
265            /**
266             * Sets the template key of this d d m template.
267             *
268             * @param templateKey the template key of this d d m template
269             */
270            public void setTemplateKey(String templateKey);
271    
272            /**
273             * Returns the name of this d d m template.
274             *
275             * @return the name of this d d m template
276             */
277            public String getName();
278    
279            /**
280             * 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.
281             *
282             * @param locale the locale of the language
283             * @return the localized name of this d d m template
284             */
285            @AutoEscape
286            public String getName(Locale locale);
287    
288            /**
289             * 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.
290             *
291             * @param locale the local of the language
292             * @param useDefault whether to use the default language if no localization exists for the requested language
293             * @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.
294             */
295            @AutoEscape
296            public String getName(Locale locale, boolean useDefault);
297    
298            /**
299             * 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.
300             *
301             * @param languageId the ID of the language
302             * @return the localized name of this d d m template
303             */
304            @AutoEscape
305            public String getName(String languageId);
306    
307            /**
308             * 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.
309             *
310             * @param languageId the ID of the language
311             * @param useDefault whether to use the default language if no localization exists for the requested language
312             * @return the localized name of this d d m template
313             */
314            @AutoEscape
315            public String getName(String languageId, boolean useDefault);
316    
317            @AutoEscape
318            public String getNameCurrentLanguageId();
319    
320            @AutoEscape
321            public String getNameCurrentValue();
322    
323            /**
324             * Returns a map of the locales and localized names of this d d m template.
325             *
326             * @return the locales and localized names of this d d m template
327             */
328            public Map<Locale, String> getNameMap();
329    
330            /**
331             * Sets the name of this d d m template.
332             *
333             * @param name the name of this d d m template
334             */
335            public void setName(String name);
336    
337            /**
338             * Sets the localized name of this d d m template in the language.
339             *
340             * @param name the localized name of this d d m template
341             * @param locale the locale of the language
342             */
343            public void setName(String name, Locale locale);
344    
345            /**
346             * Sets the localized name of this d d m template in the language, and sets the default locale.
347             *
348             * @param name the localized name of this d d m template
349             * @param locale the locale of the language
350             * @param defaultLocale the default locale
351             */
352            public void setName(String name, Locale locale, Locale defaultLocale);
353    
354            public void setNameCurrentLanguageId(String languageId);
355    
356            /**
357             * Sets the localized names of this d d m template from the map of locales and localized names.
358             *
359             * @param nameMap the locales and localized names of this d d m template
360             */
361            public void setNameMap(Map<Locale, String> nameMap);
362    
363            /**
364             * Sets the localized names of this d d m template from the map of locales and localized names, and sets the default locale.
365             *
366             * @param nameMap the locales and localized names of this d d m template
367             * @param defaultLocale the default locale
368             */
369            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
370    
371            /**
372             * Returns the description of this d d m template.
373             *
374             * @return the description of this d d m template
375             */
376            public String getDescription();
377    
378            /**
379             * 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.
380             *
381             * @param locale the locale of the language
382             * @return the localized description of this d d m template
383             */
384            @AutoEscape
385            public String getDescription(Locale locale);
386    
387            /**
388             * 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.
389             *
390             * @param locale the local of the language
391             * @param useDefault whether to use the default language if no localization exists for the requested language
392             * @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.
393             */
394            @AutoEscape
395            public String getDescription(Locale locale, boolean useDefault);
396    
397            /**
398             * 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.
399             *
400             * @param languageId the ID of the language
401             * @return the localized description of this d d m template
402             */
403            @AutoEscape
404            public String getDescription(String languageId);
405    
406            /**
407             * 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.
408             *
409             * @param languageId the ID of the language
410             * @param useDefault whether to use the default language if no localization exists for the requested language
411             * @return the localized description of this d d m template
412             */
413            @AutoEscape
414            public String getDescription(String languageId, boolean useDefault);
415    
416            @AutoEscape
417            public String getDescriptionCurrentLanguageId();
418    
419            @AutoEscape
420            public String getDescriptionCurrentValue();
421    
422            /**
423             * Returns a map of the locales and localized descriptions of this d d m template.
424             *
425             * @return the locales and localized descriptions of this d d m template
426             */
427            public Map<Locale, String> getDescriptionMap();
428    
429            /**
430             * Sets the description of this d d m template.
431             *
432             * @param description the description of this d d m template
433             */
434            public void setDescription(String description);
435    
436            /**
437             * Sets the localized description of this d d m template in the language.
438             *
439             * @param description the localized description of this d d m template
440             * @param locale the locale of the language
441             */
442            public void setDescription(String description, Locale locale);
443    
444            /**
445             * Sets the localized description of this d d m template in the language, and sets the default locale.
446             *
447             * @param description the localized description of this d d m template
448             * @param locale the locale of the language
449             * @param defaultLocale the default locale
450             */
451            public void setDescription(String description, Locale locale,
452                    Locale defaultLocale);
453    
454            public void setDescriptionCurrentLanguageId(String languageId);
455    
456            /**
457             * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions.
458             *
459             * @param descriptionMap the locales and localized descriptions of this d d m template
460             */
461            public void setDescriptionMap(Map<Locale, String> descriptionMap);
462    
463            /**
464             * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions, and sets the default locale.
465             *
466             * @param descriptionMap the locales and localized descriptions of this d d m template
467             * @param defaultLocale the default locale
468             */
469            public void setDescriptionMap(Map<Locale, String> descriptionMap,
470                    Locale defaultLocale);
471    
472            /**
473             * Returns the type of this d d m template.
474             *
475             * @return the type of this d d m template
476             */
477            @AutoEscape
478            public String getType();
479    
480            /**
481             * Sets the type of this d d m template.
482             *
483             * @param type the type of this d d m template
484             */
485            public void setType(String type);
486    
487            /**
488             * Returns the mode of this d d m template.
489             *
490             * @return the mode of this d d m template
491             */
492            @AutoEscape
493            public String getMode();
494    
495            /**
496             * Sets the mode of this d d m template.
497             *
498             * @param mode the mode of this d d m template
499             */
500            public void setMode(String mode);
501    
502            /**
503             * Returns the language of this d d m template.
504             *
505             * @return the language of this d d m template
506             */
507            @AutoEscape
508            public String getLanguage();
509    
510            /**
511             * Sets the language of this d d m template.
512             *
513             * @param language the language of this d d m template
514             */
515            public void setLanguage(String language);
516    
517            /**
518             * Returns the script of this d d m template.
519             *
520             * @return the script of this d d m template
521             */
522            @AutoEscape
523            public String getScript();
524    
525            /**
526             * Sets the script of this d d m template.
527             *
528             * @param script the script of this d d m template
529             */
530            public void setScript(String script);
531    
532            /**
533             * Returns the cacheable of this d d m template.
534             *
535             * @return the cacheable of this d d m template
536             */
537            public boolean getCacheable();
538    
539            /**
540             * Returns <code>true</code> if this d d m template is cacheable.
541             *
542             * @return <code>true</code> if this d d m template is cacheable; <code>false</code> otherwise
543             */
544            public boolean isCacheable();
545    
546            /**
547             * Sets whether this d d m template is cacheable.
548             *
549             * @param cacheable the cacheable of this d d m template
550             */
551            public void setCacheable(boolean cacheable);
552    
553            /**
554             * Returns the small image of this d d m template.
555             *
556             * @return the small image of this d d m template
557             */
558            public boolean getSmallImage();
559    
560            /**
561             * Returns <code>true</code> if this d d m template is small image.
562             *
563             * @return <code>true</code> if this d d m template is small image; <code>false</code> otherwise
564             */
565            public boolean isSmallImage();
566    
567            /**
568             * Sets whether this d d m template is small image.
569             *
570             * @param smallImage the small image of this d d m template
571             */
572            public void setSmallImage(boolean smallImage);
573    
574            /**
575             * Returns the small image ID of this d d m template.
576             *
577             * @return the small image ID of this d d m template
578             */
579            public long getSmallImageId();
580    
581            /**
582             * Sets the small image ID of this d d m template.
583             *
584             * @param smallImageId the small image ID of this d d m template
585             */
586            public void setSmallImageId(long smallImageId);
587    
588            /**
589             * Returns the small image u r l of this d d m template.
590             *
591             * @return the small image u r l of this d d m template
592             */
593            @AutoEscape
594            public String getSmallImageURL();
595    
596            /**
597             * Sets the small image u r l of this d d m template.
598             *
599             * @param smallImageURL the small image u r l of this d d m template
600             */
601            public void setSmallImageURL(String smallImageURL);
602    
603            @Override
604            public boolean isNew();
605    
606            @Override
607            public void setNew(boolean n);
608    
609            @Override
610            public boolean isCachedModel();
611    
612            @Override
613            public void setCachedModel(boolean cachedModel);
614    
615            @Override
616            public boolean isEscapedModel();
617    
618            @Override
619            public Serializable getPrimaryKeyObj();
620    
621            @Override
622            public void setPrimaryKeyObj(Serializable primaryKeyObj);
623    
624            @Override
625            public ExpandoBridge getExpandoBridge();
626    
627            @Override
628            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
629    
630            @Override
631            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
632    
633            @Override
634            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
635    
636            @Override
637            public String[] getAvailableLanguageIds();
638    
639            @Override
640            public String getDefaultLanguageId();
641    
642            @Override
643            public void prepareLocalizedFieldsForImport() throws LocaleException;
644    
645            @Override
646            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
647                    throws LocaleException;
648    
649            @Override
650            public Object clone();
651    
652            @Override
653            public int compareTo(
654                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate);
655    
656            @Override
657            public int hashCode();
658    
659            @Override
660            public CacheModel<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> toCacheModel();
661    
662            @Override
663            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate toEscapedModel();
664    
665            @Override
666            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate toUnescapedModel();
667    
668            @Override
669            public String toString();
670    
671            @Override
672            public String toXmlString();
673    }