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.journal.model;
016    
017    import com.liferay.portal.LocaleException;
018    import com.liferay.portal.kernel.exception.PortalException;
019    import com.liferay.portal.kernel.exception.SystemException;
020    import com.liferay.portal.service.ServiceContext;
021    import com.liferay.portlet.expando.model.ExpandoBridge;
022    
023    import java.io.File;
024    import java.io.Serializable;
025    
026    import java.util.Date;
027    import java.util.Locale;
028    import java.util.Map;
029    
030    /**
031     * @author Brian Wing Shun Chan
032     * @author Marcellus Tavares
033     */
034    public interface JournalTemplate
035            extends Cloneable, Comparable<JournalTemplate>, Serializable {
036    
037            public Object clone();
038    
039            @Override
040            public boolean equals(Object obj);
041    
042            public boolean getCacheable();
043    
044            public long getCompanyId();
045    
046            public Date getCreateDate();
047    
048            public String getDescription();
049    
050            public String getDescription(Locale locale);
051    
052            public String getDescription(Locale locale, boolean useDefault);
053    
054            public String getDescription(String languageId);
055    
056            public String getDescription(String languageId, boolean useDefault);
057    
058            public String getDescriptionCurrentLanguageId();
059    
060            public String getDescriptionCurrentValue();
061    
062            public Map<Locale, String> getDescriptionMap();
063    
064            public ExpandoBridge getExpandoBridge();
065    
066            public long getGroupId();
067    
068            public long getId();
069    
070            public String getLangType();
071    
072            public Map<String, Object> getModelAttributes();
073    
074            public Class<?> getModelClass();
075    
076            public String getModelClassName();
077    
078            public Date getModifiedDate();
079    
080            public String getName();
081    
082            public String getName(Locale locale);
083    
084            public String getName(Locale locale, boolean useDefault);
085    
086            public String getName(String languageId);
087    
088            public String getName(String languageId, boolean useDefault);
089    
090            public String getNameCurrentLanguageId();
091    
092            public String getNameCurrentValue();
093    
094            public Map<Locale, String> getNameMap();
095    
096            public long getPrimaryKey();
097    
098            public Serializable getPrimaryKeyObj();
099    
100            public boolean getSmallImage();
101    
102            public File getSmallImageFile() throws PortalException, SystemException;
103    
104            public long getSmallImageId();
105    
106            public String getSmallImageType() throws PortalException, SystemException;
107    
108            public String getSmallImageURL();
109    
110            public String getStructureId();
111    
112            public String getTemplateId();
113    
114            public long getUserId();
115    
116            public String getUserName();
117    
118            public String getUserUuid() throws SystemException;
119    
120            public String getUuid();
121    
122            public String getXsl();
123    
124            @Override
125            public int hashCode();
126    
127            public boolean isCacheable();
128    
129            public boolean isNew();
130    
131            public boolean isSmallImage();
132    
133            public void prepareLocalizedFieldsForImport(Locale defaultImportLocale)
134                    throws LocaleException;
135    
136            public void setCacheable(boolean cacheable);
137    
138            public void setCompanyId(long companyId);
139    
140            public void setCreateDate(Date createDate);
141    
142            public void setDescription(String description);
143    
144            public void setDescription(String description, Locale locale);
145    
146            public void setDescription(
147                    String description, Locale locale, Locale defaultLocale);
148    
149            public void setDescriptionCurrentLanguageId(String languageId);
150    
151            public void setDescriptionMap(Map<Locale, String> descriptionMap);
152    
153            public void setDescriptionMap(
154                    Map<Locale, String> descriptionMap, Locale defaultLocale);
155    
156            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
157    
158            public void setExpandoBridgeAttributes(JournalTemplate journalTemplate);
159    
160            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
161    
162            public void setGroupId(long groupId);
163    
164            public void setId(long id);
165    
166            public void setLangType(String langType);
167    
168            public void setModelAttributes(Map<String, Object> attributes);
169    
170            public void setModifiedDate(Date modifiedDate);
171    
172            public void setName(String name);
173    
174            public void setName(String name, Locale locale);
175    
176            public void setName(String name, Locale locale, Locale defaultLocale);
177    
178            public void setNameCurrentLanguageId(String languageId);
179    
180            public void setNameMap(Map<Locale, String> nameMap);
181    
182            public void setNameMap(Map<Locale, String> nameMap, Locale defaultLocale);
183    
184            public void setNew(boolean n);
185    
186            public void setPrimaryKey(long primaryKey);
187    
188            public void setPrimaryKeyObj(Serializable primaryKeyObj);
189    
190            public void setSmallImage(boolean smallImage);
191    
192            public void setSmallImageId(long smallImageId);
193    
194            public void setSmallImageType(String smallImageType);
195    
196            public void setSmallImageURL(String smallImageURL);
197    
198            public void setStructureId(String structureId);
199    
200            public void setTemplateId(String templateId);
201    
202            public void setUserId(long userId);
203    
204            public void setUserName(String userName);
205    
206            public void setUserUuid(String userUuid);
207    
208            public void setUuid(String uuid);
209    
210            public void setXsl(String xsl);
211    
212    }