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 version user ID of this d d m template.
186             *
187             * @return the version user ID of this d d m template
188             */
189            public long getVersionUserId();
190    
191            /**
192             * Sets the version user ID of this d d m template.
193             *
194             * @param versionUserId the version user ID of this d d m template
195             */
196            public void setVersionUserId(long versionUserId);
197    
198            /**
199             * Returns the version user uuid of this d d m template.
200             *
201             * @return the version user uuid of this d d m template
202             */
203            public String getVersionUserUuid();
204    
205            /**
206             * Sets the version user uuid of this d d m template.
207             *
208             * @param versionUserUuid the version user uuid of this d d m template
209             */
210            public void setVersionUserUuid(String versionUserUuid);
211    
212            /**
213             * Returns the version user name of this d d m template.
214             *
215             * @return the version user name of this d d m template
216             */
217            @AutoEscape
218            public String getVersionUserName();
219    
220            /**
221             * Sets the version user name of this d d m template.
222             *
223             * @param versionUserName the version user name of this d d m template
224             */
225            public void setVersionUserName(String versionUserName);
226    
227            /**
228             * Returns the create date of this d d m template.
229             *
230             * @return the create date of this d d m template
231             */
232            @Override
233            public Date getCreateDate();
234    
235            /**
236             * Sets the create date of this d d m template.
237             *
238             * @param createDate the create date of this d d m template
239             */
240            @Override
241            public void setCreateDate(Date createDate);
242    
243            /**
244             * Returns the modified date of this d d m template.
245             *
246             * @return the modified date of this d d m template
247             */
248            @Override
249            public Date getModifiedDate();
250    
251            /**
252             * Sets the modified date of this d d m template.
253             *
254             * @param modifiedDate the modified date of this d d m template
255             */
256            @Override
257            public void setModifiedDate(Date modifiedDate);
258    
259            /**
260             * Returns the fully qualified class name of this d d m template.
261             *
262             * @return the fully qualified class name of this d d m template
263             */
264            @Override
265            public String getClassName();
266    
267            public void setClassName(String className);
268    
269            /**
270             * Returns the class name ID of this d d m template.
271             *
272             * @return the class name ID of this d d m template
273             */
274            @Override
275            public long getClassNameId();
276    
277            /**
278             * Sets the class name ID of this d d m template.
279             *
280             * @param classNameId the class name ID of this d d m template
281             */
282            @Override
283            public void setClassNameId(long classNameId);
284    
285            /**
286             * Returns the class p k of this d d m template.
287             *
288             * @return the class p k of this d d m template
289             */
290            @Override
291            public long getClassPK();
292    
293            /**
294             * Sets the class p k of this d d m template.
295             *
296             * @param classPK the class p k of this d d m template
297             */
298            @Override
299            public void setClassPK(long classPK);
300    
301            /**
302             * Returns the resource class name ID of this d d m template.
303             *
304             * @return the resource class name ID of this d d m template
305             */
306            public long getResourceClassNameId();
307    
308            /**
309             * Sets the resource class name ID of this d d m template.
310             *
311             * @param resourceClassNameId the resource class name ID of this d d m template
312             */
313            public void setResourceClassNameId(long resourceClassNameId);
314    
315            /**
316             * Returns the template key of this d d m template.
317             *
318             * @return the template key of this d d m template
319             */
320            public String getTemplateKey();
321    
322            /**
323             * Sets the template key of this d d m template.
324             *
325             * @param templateKey the template key of this d d m template
326             */
327            public void setTemplateKey(String templateKey);
328    
329            /**
330             * Returns the version of this d d m template.
331             *
332             * @return the version of this d d m template
333             */
334            @AutoEscape
335            public String getVersion();
336    
337            /**
338             * Sets the version of this d d m template.
339             *
340             * @param version the version of this d d m template
341             */
342            public void setVersion(String version);
343    
344            /**
345             * Returns the name of this d d m template.
346             *
347             * @return the name of this d d m template
348             */
349            public String getName();
350    
351            /**
352             * 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.
353             *
354             * @param locale the locale of the language
355             * @return the localized name of this d d m template
356             */
357            @AutoEscape
358            public String getName(Locale locale);
359    
360            /**
361             * 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.
362             *
363             * @param locale the local of the language
364             * @param useDefault whether to use the default language if no localization exists for the requested language
365             * @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.
366             */
367            @AutoEscape
368            public String getName(Locale locale, boolean useDefault);
369    
370            /**
371             * 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.
372             *
373             * @param languageId the ID of the language
374             * @return the localized name of this d d m template
375             */
376            @AutoEscape
377            public String getName(String languageId);
378    
379            /**
380             * 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.
381             *
382             * @param languageId the ID of the language
383             * @param useDefault whether to use the default language if no localization exists for the requested language
384             * @return the localized name of this d d m template
385             */
386            @AutoEscape
387            public String getName(String languageId, boolean useDefault);
388    
389            @AutoEscape
390            public String getNameCurrentLanguageId();
391    
392            @AutoEscape
393            public String getNameCurrentValue();
394    
395            /**
396             * Returns a map of the locales and localized names of this d d m template.
397             *
398             * @return the locales and localized names of this d d m template
399             */
400            public Map<Locale, String> getNameMap();
401    
402            /**
403             * Sets the name of this d d m template.
404             *
405             * @param name the name of this d d m template
406             */
407            public void setName(String name);
408    
409            /**
410             * Sets the localized name of this d d m template in the language.
411             *
412             * @param name the localized name of this d d m template
413             * @param locale the locale of the language
414             */
415            public void setName(String name, Locale locale);
416    
417            /**
418             * Sets the localized name of this d d m template in the language, and sets the default locale.
419             *
420             * @param name the localized name of this d d m template
421             * @param locale the locale of the language
422             * @param defaultLocale the default locale
423             */
424            public void setName(String name, Locale locale, Locale defaultLocale);
425    
426            public void setNameCurrentLanguageId(String languageId);
427    
428            /**
429             * Sets the localized names of this d d m template from the map of locales and localized names.
430             *
431             * @param nameMap the locales and localized names of this d d m template
432             */
433            public void setNameMap(Map<Locale, String> nameMap);
434    
435            /**
436             * Sets the localized names of this d d m template from the map of locales and localized names, and sets the default locale.
437             *
438             * @param nameMap the locales and localized names of this d d m template
439             * @param defaultLocale the default locale
440             */
441            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
442    
443            /**
444             * Returns the description of this d d m template.
445             *
446             * @return the description of this d d m template
447             */
448            public String getDescription();
449    
450            /**
451             * 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.
452             *
453             * @param locale the locale of the language
454             * @return the localized description of this d d m template
455             */
456            @AutoEscape
457            public String getDescription(Locale locale);
458    
459            /**
460             * 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.
461             *
462             * @param locale the local of the language
463             * @param useDefault whether to use the default language if no localization exists for the requested language
464             * @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.
465             */
466            @AutoEscape
467            public String getDescription(Locale locale, boolean useDefault);
468    
469            /**
470             * 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.
471             *
472             * @param languageId the ID of the language
473             * @return the localized description of this d d m template
474             */
475            @AutoEscape
476            public String getDescription(String languageId);
477    
478            /**
479             * 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.
480             *
481             * @param languageId the ID of the language
482             * @param useDefault whether to use the default language if no localization exists for the requested language
483             * @return the localized description of this d d m template
484             */
485            @AutoEscape
486            public String getDescription(String languageId, boolean useDefault);
487    
488            @AutoEscape
489            public String getDescriptionCurrentLanguageId();
490    
491            @AutoEscape
492            public String getDescriptionCurrentValue();
493    
494            /**
495             * Returns a map of the locales and localized descriptions of this d d m template.
496             *
497             * @return the locales and localized descriptions of this d d m template
498             */
499            public Map<Locale, String> getDescriptionMap();
500    
501            /**
502             * Sets the description of this d d m template.
503             *
504             * @param description the description of this d d m template
505             */
506            public void setDescription(String description);
507    
508            /**
509             * Sets the localized description of this d d m template in the language.
510             *
511             * @param description the localized description of this d d m template
512             * @param locale the locale of the language
513             */
514            public void setDescription(String description, Locale locale);
515    
516            /**
517             * Sets the localized description of this d d m template in the language, and sets the default locale.
518             *
519             * @param description the localized description of this d d m template
520             * @param locale the locale of the language
521             * @param defaultLocale the default locale
522             */
523            public void setDescription(String description, Locale locale,
524                    Locale defaultLocale);
525    
526            public void setDescriptionCurrentLanguageId(String languageId);
527    
528            /**
529             * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions.
530             *
531             * @param descriptionMap the locales and localized descriptions of this d d m template
532             */
533            public void setDescriptionMap(Map<Locale, String> descriptionMap);
534    
535            /**
536             * Sets the localized descriptions of this d d m template from the map of locales and localized descriptions, and sets the default locale.
537             *
538             * @param descriptionMap the locales and localized descriptions of this d d m template
539             * @param defaultLocale the default locale
540             */
541            public void setDescriptionMap(Map<Locale, String> descriptionMap,
542                    Locale defaultLocale);
543    
544            /**
545             * Returns the type of this d d m template.
546             *
547             * @return the type of this d d m template
548             */
549            @AutoEscape
550            public String getType();
551    
552            /**
553             * Sets the type of this d d m template.
554             *
555             * @param type the type of this d d m template
556             */
557            public void setType(String type);
558    
559            /**
560             * Returns the mode of this d d m template.
561             *
562             * @return the mode of this d d m template
563             */
564            @AutoEscape
565            public String getMode();
566    
567            /**
568             * Sets the mode of this d d m template.
569             *
570             * @param mode the mode of this d d m template
571             */
572            public void setMode(String mode);
573    
574            /**
575             * Returns the language of this d d m template.
576             *
577             * @return the language of this d d m template
578             */
579            @AutoEscape
580            public String getLanguage();
581    
582            /**
583             * Sets the language of this d d m template.
584             *
585             * @param language the language of this d d m template
586             */
587            public void setLanguage(String language);
588    
589            /**
590             * Returns the script of this d d m template.
591             *
592             * @return the script of this d d m template
593             */
594            @AutoEscape
595            public String getScript();
596    
597            /**
598             * Sets the script of this d d m template.
599             *
600             * @param script the script of this d d m template
601             */
602            public void setScript(String script);
603    
604            /**
605             * Returns the cacheable of this d d m template.
606             *
607             * @return the cacheable of this d d m template
608             */
609            public boolean getCacheable();
610    
611            /**
612             * Returns <code>true</code> if this d d m template is cacheable.
613             *
614             * @return <code>true</code> if this d d m template is cacheable; <code>false</code> otherwise
615             */
616            public boolean isCacheable();
617    
618            /**
619             * Sets whether this d d m template is cacheable.
620             *
621             * @param cacheable the cacheable of this d d m template
622             */
623            public void setCacheable(boolean cacheable);
624    
625            /**
626             * Returns the small image of this d d m template.
627             *
628             * @return the small image of this d d m template
629             */
630            public boolean getSmallImage();
631    
632            /**
633             * Returns <code>true</code> if this d d m template is small image.
634             *
635             * @return <code>true</code> if this d d m template is small image; <code>false</code> otherwise
636             */
637            public boolean isSmallImage();
638    
639            /**
640             * Sets whether this d d m template is small image.
641             *
642             * @param smallImage the small image of this d d m template
643             */
644            public void setSmallImage(boolean smallImage);
645    
646            /**
647             * Returns the small image ID of this d d m template.
648             *
649             * @return the small image ID of this d d m template
650             */
651            public long getSmallImageId();
652    
653            /**
654             * Sets the small image ID of this d d m template.
655             *
656             * @param smallImageId the small image ID of this d d m template
657             */
658            public void setSmallImageId(long smallImageId);
659    
660            /**
661             * Returns the small image u r l of this d d m template.
662             *
663             * @return the small image u r l of this d d m template
664             */
665            @AutoEscape
666            public String getSmallImageURL();
667    
668            /**
669             * Sets the small image u r l of this d d m template.
670             *
671             * @param smallImageURL the small image u r l of this d d m template
672             */
673            public void setSmallImageURL(String smallImageURL);
674    
675            @Override
676            public boolean isNew();
677    
678            @Override
679            public void setNew(boolean n);
680    
681            @Override
682            public boolean isCachedModel();
683    
684            @Override
685            public void setCachedModel(boolean cachedModel);
686    
687            @Override
688            public boolean isEscapedModel();
689    
690            @Override
691            public Serializable getPrimaryKeyObj();
692    
693            @Override
694            public void setPrimaryKeyObj(Serializable primaryKeyObj);
695    
696            @Override
697            public ExpandoBridge getExpandoBridge();
698    
699            @Override
700            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
701    
702            @Override
703            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
704    
705            @Override
706            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
707    
708            @Override
709            public String[] getAvailableLanguageIds();
710    
711            @Override
712            public String getDefaultLanguageId();
713    
714            @Override
715            public void prepareLocalizedFieldsForImport() throws LocaleException;
716    
717            @Override
718            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
719                    throws LocaleException;
720    
721            @Override
722            public Object clone();
723    
724            @Override
725            public int compareTo(
726                    com.liferay.portlet.dynamicdatamapping.model.DDMTemplate ddmTemplate);
727    
728            @Override
729            public int hashCode();
730    
731            @Override
732            public CacheModel<com.liferay.portlet.dynamicdatamapping.model.DDMTemplate> toCacheModel();
733    
734            @Override
735            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate toEscapedModel();
736    
737            @Override
738            public com.liferay.portlet.dynamicdatamapping.model.DDMTemplate toUnescapedModel();
739    
740            @Override
741            public String toString();
742    
743            @Override
744            public String toXmlString();
745    }