001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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    
030    /**
031     * 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.
032     *
033     * <p>
034     * 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}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see JournalTemplate
039     * @see com.liferay.portlet.journal.model.impl.JournalTemplateImpl
040     * @see com.liferay.portlet.journal.model.impl.JournalTemplateModelImpl
041     * @generated
042     */
043    public interface JournalTemplateModel extends BaseModel<JournalTemplate>,
044            GroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a journal template model instance should use the {@link JournalTemplate} interface instead.
049             */
050    
051            /**
052             * Gets the primary key of this journal template.
053             *
054             * @return the primary key of this journal template
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this journal template
060             *
061             * @param primaryKey the primary key of this journal template
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Gets the uuid of this journal template.
067             *
068             * @return the uuid of this journal template
069             */
070            @AutoEscape
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this journal template.
075             *
076             * @param uuid the uuid of this journal template
077             */
078            public void setUuid(String uuid);
079    
080            /**
081             * Gets the ID of this journal template.
082             *
083             * @return the ID of this journal template
084             */
085            public long getId();
086    
087            /**
088             * Sets the ID of this journal template.
089             *
090             * @param id the ID of this journal template
091             */
092            public void setId(long id);
093    
094            /**
095             * Gets the group ID of this journal template.
096             *
097             * @return the group ID of this journal template
098             */
099            public long getGroupId();
100    
101            /**
102             * Sets the group ID of this journal template.
103             *
104             * @param groupId the group ID of this journal template
105             */
106            public void setGroupId(long groupId);
107    
108            /**
109             * Gets the company ID of this journal template.
110             *
111             * @return the company ID of this journal template
112             */
113            public long getCompanyId();
114    
115            /**
116             * Sets the company ID of this journal template.
117             *
118             * @param companyId the company ID of this journal template
119             */
120            public void setCompanyId(long companyId);
121    
122            /**
123             * Gets the user ID of this journal template.
124             *
125             * @return the user ID of this journal template
126             */
127            public long getUserId();
128    
129            /**
130             * Sets the user ID of this journal template.
131             *
132             * @param userId the user ID of this journal template
133             */
134            public void setUserId(long userId);
135    
136            /**
137             * Gets the user uuid of this journal template.
138             *
139             * @return the user uuid of this journal template
140             * @throws SystemException if a system exception occurred
141             */
142            public String getUserUuid() throws SystemException;
143    
144            /**
145             * Sets the user uuid of this journal template.
146             *
147             * @param userUuid the user uuid of this journal template
148             */
149            public void setUserUuid(String userUuid);
150    
151            /**
152             * Gets the user name of this journal template.
153             *
154             * @return the user name of this journal template
155             */
156            @AutoEscape
157            public String getUserName();
158    
159            /**
160             * Sets the user name of this journal template.
161             *
162             * @param userName the user name of this journal template
163             */
164            public void setUserName(String userName);
165    
166            /**
167             * Gets the create date of this journal template.
168             *
169             * @return the create date of this journal template
170             */
171            public Date getCreateDate();
172    
173            /**
174             * Sets the create date of this journal template.
175             *
176             * @param createDate the create date of this journal template
177             */
178            public void setCreateDate(Date createDate);
179    
180            /**
181             * Gets the modified date of this journal template.
182             *
183             * @return the modified date of this journal template
184             */
185            public Date getModifiedDate();
186    
187            /**
188             * Sets the modified date of this journal template.
189             *
190             * @param modifiedDate the modified date of this journal template
191             */
192            public void setModifiedDate(Date modifiedDate);
193    
194            /**
195             * Gets the template ID of this journal template.
196             *
197             * @return the template ID of this journal template
198             */
199            public String getTemplateId();
200    
201            /**
202             * Sets the template ID of this journal template.
203             *
204             * @param templateId the template ID of this journal template
205             */
206            public void setTemplateId(String templateId);
207    
208            /**
209             * Gets the structure ID of this journal template.
210             *
211             * @return the structure ID of this journal template
212             */
213            public String getStructureId();
214    
215            /**
216             * Sets the structure ID of this journal template.
217             *
218             * @param structureId the structure ID of this journal template
219             */
220            public void setStructureId(String structureId);
221    
222            /**
223             * Gets the name of this journal template.
224             *
225             * @return the name of this journal template
226             */
227            @AutoEscape
228            public String getName();
229    
230            /**
231             * Sets the name of this journal template.
232             *
233             * @param name the name of this journal template
234             */
235            public void setName(String name);
236    
237            /**
238             * Gets the description of this journal template.
239             *
240             * @return the description of this journal template
241             */
242            @AutoEscape
243            public String getDescription();
244    
245            /**
246             * Sets the description of this journal template.
247             *
248             * @param description the description of this journal template
249             */
250            public void setDescription(String description);
251    
252            /**
253             * Gets the xsl of this journal template.
254             *
255             * @return the xsl of this journal template
256             */
257            @AutoEscape
258            public String getXsl();
259    
260            /**
261             * Sets the xsl of this journal template.
262             *
263             * @param xsl the xsl of this journal template
264             */
265            public void setXsl(String xsl);
266    
267            /**
268             * Gets the lang type of this journal template.
269             *
270             * @return the lang type of this journal template
271             */
272            @AutoEscape
273            public String getLangType();
274    
275            /**
276             * Sets the lang type of this journal template.
277             *
278             * @param langType the lang type of this journal template
279             */
280            public void setLangType(String langType);
281    
282            /**
283             * Gets the cacheable of this journal template.
284             *
285             * @return the cacheable of this journal template
286             */
287            public boolean getCacheable();
288    
289            /**
290             * Determines if this journal template is cacheable.
291             *
292             * @return <code>true</code> if this journal template is cacheable; <code>false</code> otherwise
293             */
294            public boolean isCacheable();
295    
296            /**
297             * Sets whether this journal template is cacheable.
298             *
299             * @param cacheable the cacheable of this journal template
300             */
301            public void setCacheable(boolean cacheable);
302    
303            /**
304             * Gets the small image of this journal template.
305             *
306             * @return the small image of this journal template
307             */
308            public boolean getSmallImage();
309    
310            /**
311             * Determines if this journal template is small image.
312             *
313             * @return <code>true</code> if this journal template is small image; <code>false</code> otherwise
314             */
315            public boolean isSmallImage();
316    
317            /**
318             * Sets whether this journal template is small image.
319             *
320             * @param smallImage the small image of this journal template
321             */
322            public void setSmallImage(boolean smallImage);
323    
324            /**
325             * Gets the small image ID of this journal template.
326             *
327             * @return the small image ID of this journal template
328             */
329            public long getSmallImageId();
330    
331            /**
332             * Sets the small image ID of this journal template.
333             *
334             * @param smallImageId the small image ID of this journal template
335             */
336            public void setSmallImageId(long smallImageId);
337    
338            /**
339             * Gets the small image u r l of this journal template.
340             *
341             * @return the small image u r l of this journal template
342             */
343            @AutoEscape
344            public String getSmallImageURL();
345    
346            /**
347             * Sets the small image u r l of this journal template.
348             *
349             * @param smallImageURL the small image u r l of this journal template
350             */
351            public void setSmallImageURL(String smallImageURL);
352    
353            public boolean isNew();
354    
355            public void setNew(boolean n);
356    
357            public boolean isCachedModel();
358    
359            public void setCachedModel(boolean cachedModel);
360    
361            public boolean isEscapedModel();
362    
363            public void setEscapedModel(boolean escapedModel);
364    
365            public Serializable getPrimaryKeyObj();
366    
367            public void setPrimaryKeyObj(Serializable primaryKeyObj);
368    
369            public ExpandoBridge getExpandoBridge();
370    
371            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
372    
373            public Object clone();
374    
375            public int compareTo(JournalTemplate journalTemplate);
376    
377            public int hashCode();
378    
379            public CacheModel<JournalTemplate> toCacheModel();
380    
381            public JournalTemplate toEscapedModel();
382    
383            public String toString();
384    
385            public String toXmlString();
386    }