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    
030    /**
031     * The base model interface for the JournalFolder service. Represents a row in the "JournalFolder" 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.JournalFolderModelImpl} 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.JournalFolderImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see JournalFolder
039     * @see com.liferay.portlet.journal.model.impl.JournalFolderImpl
040     * @see com.liferay.portlet.journal.model.impl.JournalFolderModelImpl
041     * @generated
042     */
043    public interface JournalFolderModel extends BaseModel<JournalFolder>,
044            GroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a journal folder model instance should use the {@link JournalFolder} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this journal folder.
053             *
054             * @return the primary key of this journal folder
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this journal folder.
060             *
061             * @param primaryKey the primary key of this journal folder
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the uuid of this journal folder.
067             *
068             * @return the uuid of this journal folder
069             */
070            @AutoEscape
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this journal folder.
075             *
076             * @param uuid the uuid of this journal folder
077             */
078            public void setUuid(String uuid);
079    
080            /**
081             * Returns the folder ID of this journal folder.
082             *
083             * @return the folder ID of this journal folder
084             */
085            public long getFolderId();
086    
087            /**
088             * Sets the folder ID of this journal folder.
089             *
090             * @param folderId the folder ID of this journal folder
091             */
092            public void setFolderId(long folderId);
093    
094            /**
095             * Returns the group ID of this journal folder.
096             *
097             * @return the group ID of this journal folder
098             */
099            public long getGroupId();
100    
101            /**
102             * Sets the group ID of this journal folder.
103             *
104             * @param groupId the group ID of this journal folder
105             */
106            public void setGroupId(long groupId);
107    
108            /**
109             * Returns the company ID of this journal folder.
110             *
111             * @return the company ID of this journal folder
112             */
113            public long getCompanyId();
114    
115            /**
116             * Sets the company ID of this journal folder.
117             *
118             * @param companyId the company ID of this journal folder
119             */
120            public void setCompanyId(long companyId);
121    
122            /**
123             * Returns the user ID of this journal folder.
124             *
125             * @return the user ID of this journal folder
126             */
127            public long getUserId();
128    
129            /**
130             * Sets the user ID of this journal folder.
131             *
132             * @param userId the user ID of this journal folder
133             */
134            public void setUserId(long userId);
135    
136            /**
137             * Returns the user uuid of this journal folder.
138             *
139             * @return the user uuid of this journal folder
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 folder.
146             *
147             * @param userUuid the user uuid of this journal folder
148             */
149            public void setUserUuid(String userUuid);
150    
151            /**
152             * Returns the user name of this journal folder.
153             *
154             * @return the user name of this journal folder
155             */
156            @AutoEscape
157            public String getUserName();
158    
159            /**
160             * Sets the user name of this journal folder.
161             *
162             * @param userName the user name of this journal folder
163             */
164            public void setUserName(String userName);
165    
166            /**
167             * Returns the create date of this journal folder.
168             *
169             * @return the create date of this journal folder
170             */
171            public Date getCreateDate();
172    
173            /**
174             * Sets the create date of this journal folder.
175             *
176             * @param createDate the create date of this journal folder
177             */
178            public void setCreateDate(Date createDate);
179    
180            /**
181             * Returns the modified date of this journal folder.
182             *
183             * @return the modified date of this journal folder
184             */
185            public Date getModifiedDate();
186    
187            /**
188             * Sets the modified date of this journal folder.
189             *
190             * @param modifiedDate the modified date of this journal folder
191             */
192            public void setModifiedDate(Date modifiedDate);
193    
194            /**
195             * Returns the parent folder ID of this journal folder.
196             *
197             * @return the parent folder ID of this journal folder
198             */
199            public long getParentFolderId();
200    
201            /**
202             * Sets the parent folder ID of this journal folder.
203             *
204             * @param parentFolderId the parent folder ID of this journal folder
205             */
206            public void setParentFolderId(long parentFolderId);
207    
208            /**
209             * Returns the name of this journal folder.
210             *
211             * @return the name of this journal folder
212             */
213            @AutoEscape
214            public String getName();
215    
216            /**
217             * Sets the name of this journal folder.
218             *
219             * @param name the name of this journal folder
220             */
221            public void setName(String name);
222    
223            /**
224             * Returns the description of this journal folder.
225             *
226             * @return the description of this journal folder
227             */
228            @AutoEscape
229            public String getDescription();
230    
231            /**
232             * Sets the description of this journal folder.
233             *
234             * @param description the description of this journal folder
235             */
236            public void setDescription(String description);
237    
238            public boolean isNew();
239    
240            public void setNew(boolean n);
241    
242            public boolean isCachedModel();
243    
244            public void setCachedModel(boolean cachedModel);
245    
246            public boolean isEscapedModel();
247    
248            public Serializable getPrimaryKeyObj();
249    
250            public void setPrimaryKeyObj(Serializable primaryKeyObj);
251    
252            public ExpandoBridge getExpandoBridge();
253    
254            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
255    
256            public Object clone();
257    
258            public int compareTo(JournalFolder journalFolder);
259    
260            public int hashCode();
261    
262            public CacheModel<JournalFolder> toCacheModel();
263    
264            public JournalFolder toEscapedModel();
265    
266            public String toString();
267    
268            public String toXmlString();
269    }