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 version of this d d m template.
274             *
275             * @return the version of this d d m template
276             */
277            @AutoEscape
278            public String getVersion();
279    
280            /**
281             * Sets the version of this d d m template.
282             *
283             * @param version the version of this d d m template
284             */
285            public void setVersion(String version);
286    
287            /**
288             * Returns the name of this d d m template.
289             *
290             * @return the name of this d d m template
291             */
292            public String getName();
293    
294            /**
295             * 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.
296             *
297             * @param locale the locale of the language
298             * @return the localized name of this d d m template
299             */
300            @AutoEscape
301            public String getName(Locale locale);
302    
303            /**
304             * 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.
305             *
306             * @param locale the local of the language
307             * @param useDefault whether to use the default language if no localization exists for the requested language
308             * @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.
309             */
310            @AutoEscape
311            public String getName(Locale locale, boolean useDefault);
312    
313            /**
314             * 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.
315             *
316             * @param languageId the ID of the language
317             * @return the localized name of this d d m template
318             */
319            @AutoEscape
320            public String getName(String languageId);
321    
322            /**
323             * 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.
324             *
325             * @param languageId the ID of the language
326             * @param useDefault whether to use the default language if no localization exists for the requested language
327             * @return the localized name of this d d m template
328             */
329            @AutoEscape
330            public String getName(String languageId, boolean useDefault);
331    
332            @AutoEscape
333            public String getNameCurrentLanguageId();
334    
335            @AutoEscape
336            public String getNameCurrentValue();
337    
338            /**
339             * Returns a map of the locales and localized names of this d d m template.
340             *
341             * @return the locales and localized names of this d d m template
342             */
343            public Map<Locale, String> getNameMap();
344    
345            /**
346             * Sets the name of this d d m template.
347             *
348             * @param name the name of this d d m template
349             */
350            public void setName(String name);
351    
352            /**
353             * Sets the localized name of this d d m template in the language.
354             *
355             * @param name the localized name of this d d m template
356             * @param locale the locale of the language
357             */
358            public void setName(String name, Locale locale);
359    
360            /**
361             * Sets the localized name of this d d m template in the language, and sets the default locale.
362             *
363             * @param name the localized name of this d d m template
364             * @param locale the locale of the language
365             * @param defaultLocale the default locale
366             */
367            public void setName(String name, Locale locale, Locale defaultLocale);
368    
369            public void setNameCurrentLanguageId(String languageId);
370    
371            /**
372             * Sets the localized names of this d d m template from the map of locales and localized names.
373             *
374             * @param nameMap the locales and localized names of this d d m template
375             */
376            public void setNameMap(Map<Locale, String> nameMap);
377    
378            /**
379             * Sets the localized names of this d d m template from the map of locales and localized names, and sets the default locale.
380             *
381             * @param nameMap the locales and localized names of this d d m template
382             * @param defaultLocale the default locale
383             */
384            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
385    
386            /**
387             * Returns the description of this d d m template.
388             *
389             * @return the description of this d d m template
390             */
391            public String getDescription();
392    
393            /**
394             * 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.
395             *
396             * @param locale the locale of the language
397             * @return the localized description of this d d m template
398             */
399            @AutoEscape
400            public String getDescription(Locale locale);
401    
402            /**
403             * 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.
404             *
405             * @param locale the local of the language
406             * @param useDefault whether to use the default language if no localization exists for the requested language
407             * @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.
408             */
409            @AutoEscape
410            public String getDescription(Locale locale, boolean useDefault);
411    
412            /**
413             * 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.
414             *
415             * @param languageId the ID of the language
416             * @return the localized description of this d d m template
417             */
418            @AutoEscape
419            public String getDescription(String languageId);
420    
421            /**
422             * 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.
423             *
424             * @param languageId the ID of the language
425             * @param useDefault whether to use the default language if no localization exists for the requested language
426             * @return the localized description of this d d m template
427             */
428            @AutoEscape
429            public String getDescription(String languageId, boolean useDefault);
430    
431            @AutoEscape
432            public String getDescriptionCurrentLanguageId();
433    
434            @AutoEscape
435            public String getDescriptionCurrentValue();
436    
437            /**
438             * Returns a map of the locales and localized descriptions of this d d m template.
439             *
440             * @return the locales and localized descriptions of this d d m template
441             */
442            public Map<Locale, String> getDescriptionMap();
443    
444            /**
445             * Sets the description of this d d m template.
446             *
447             * @param description the description of this d d m template
448             */
449            public void setDescription(String description);
450    
451            /**
452             * Sets the localized description of this d d m template in the language.
453             *
454             * @param description the localized description of this d d m template
455             * @param locale the locale of the language
456             */
457            public void setDescription(String description, Locale locale);
458    
459            /**
460             * Sets the localized description of this d d m template in the language, and sets the default locale.
461             *
462             * @param description the localized description of this d d m template
463             * @param locale the locale of the language
464             * @param defaultLocale the default locale
465             */
466            public void setDescription(String description, Locale locale,
467                    Locale defaultLocale);
468    
469            public void setDescriptionCurrentLanguageId(String languageId);
470    
471            /**
472             * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions.
473             *
474             * @param descriptionMap the locales and localized descriptions of this d d m template
475             */
476            public void setDescriptionMap(Map<Locale, String> descriptionMap);
477    
478            /**
479             * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions, and sets the default locale.
480             *
481             * @param descriptionMap the locales and localized descriptions of this d d m template
482             * @param defaultLocale the default locale
483             */
484            public void setDescriptionMap(Map<Locale, String> descriptionMap,
485                    Locale defaultLocale);
486    
487            /**
488             * Returns the type of this d d m template.
489             *
490             * @return the type of this d d m template
491             */
492            @AutoEscape
493            public String getType();
494    
495            /**
496             * Sets the type of this d d m template.
497             *
498             * @param type the type of this d d m template
499             */
500            public void setType(String type);
501    
502            /**
503             * Returns the mode of this d d m template.
504             *
505             * @return the mode of this d d m template
506             */
507            @AutoEscape
508            public String getMode();
509    
510            /**
511             * Sets the mode of this d d m template.
512             *
513             * @param mode the mode of this d d m template
514             */
515            public void setMode(String mode);
516    
517            /**
518             * Returns the language of this d d m template.
519             *
520             * @return the language of this d d m template
521             */
522            @AutoEscape
523            public String getLanguage();
524    
525            /**
526             * Sets the language of this d d m template.
527             *
528             * @param language the language of this d d m template
529             */
530            public void setLanguage(String language);
531    
532            /**
533             * Returns the script of this d d m template.
534             *
535             * @return the script of this d d m template
536             */
537            @AutoEscape
538            public String getScript();
539    
540            /**
541             * Sets the script of this d d m template.
542             *
543             * @param script the script of this d d m template
544             */
545            public void setScript(String script);
546    
547            /**
548             * Returns the cacheable of this d d m template.
549             *
550             * @return the cacheable of this d d m template
551             */
552            public boolean getCacheable();
553    
554            /**
555             * Returns <code>true</code> if this d d m template is cacheable.
556             *
557             * @return <code>true</code> if this d d m template is cacheable; <code>false</code> otherwise
558             */
559            public boolean isCacheable();
560    
561            /**
562             * Sets whether this d d m template is cacheable.
563             *
564             * @param cacheable the cacheable of this d d m template
565             */
566            public void setCacheable(boolean cacheable);
567    
568            /**
569             * Returns the small image of this d d m template.
570             *
571             * @return the small image of this d d m template
572             */
573            public boolean getSmallImage();
574    
575            /**
576             * Returns <code>true</code> if this d d m template is small image.
577             *
578             * @return <code>true</code> if this d d m template is small image; <code>false</code> otherwise
579             */
580            public boolean isSmallImage();
581    
582            /**
583             * Sets whether this d d m template is small image.
584             *
585             * @param smallImage the small image of this d d m template
586             */
587            public void setSmallImage(boolean smallImage);
588    
589            /**
590             * Returns the small image ID of this d d m template.
591             *
592             * @return the small image ID of this d d m template
593             */
594            public long getSmallImageId();
595    
596            /**
597             * Sets the small image ID of this d d m template.
598             *
599             * @param smallImageId the small image ID of this d d m template
600             */
601            public void setSmallImageId(long smallImageId);
602    
603            /**
604             * Returns the small image u r l of this d d m template.
605             *
606             * @return the small image u r l of this d d m template
607             */
608            @AutoEscape
609            public String getSmallImageURL();
610    
611            /**
612             * Sets the small image u r l of this d d m template.
613             *
614             * @param smallImageURL the small image u r l of this d d m template
615             */
616            public void setSmallImageURL(String smallImageURL);
617    
618            @Override
619            public boolean isNew();
620    
621            @Override
622            public void setNew(boolean n);
623    
624            @Override
625            public boolean isCachedModel();
626    
627            @Override
628            public void setCachedModel(boolean cachedModel);
629    
630            @Override
631            public boolean isEscapedModel();
632    
633            @Override
634            public Serializable getPrimaryKeyObj();
635    
636            @Override
637            public void setPrimaryKeyObj(Serializable primaryKeyObj);
638    
639            @Override
640            public ExpandoBridge getExpandoBridge();
641    
642            @Override
643            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
644    
645            @Override
646            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
647    
648            @Override
649            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
650    
651            @Override
652            public String[] getAvailableLanguageIds();
653    
654            @Override
655            public String getDefaultLanguageId();
656    
657            @Override
658            public void prepareLocalizedFieldsForImport() throws LocaleException;
659    
660            @Override
661            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
662                    throws LocaleException;
663    
664            @Override
665            public Object clone();
666    
667            @Override
668            public int compareTo(
669                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate);
670    
671            @Override
672            public int hashCode();
673    
674            @Override
675            public CacheModel<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> toCacheModel();
676    
677            @Override
678            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate toEscapedModel();
679    
680            @Override
681            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate toUnescapedModel();
682    
683            @Override
684            public String toString();
685    
686            @Override
687            public String toXmlString();
688    }