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