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