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