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