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