001    /**
002     * Copyright (c) 2000-2010 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.annotation.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    import java.util.Date;
027    
028    /**
029     * 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.
030     *
031     * <p>
032     * 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}.
033     * </p>
034     *
035     * <p>
036     * Never modify or reference this interface directly. All methods that expect a bookmarks folder model instance should use the {@link BookmarksFolder} interface instead.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see BookmarksFolder
041     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksFolderImpl
042     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl
043     * @generated
044     */
045    public interface BookmarksFolderModel extends BaseModel<BookmarksFolder> {
046            /**
047             * Gets the primary key of this bookmarks folder.
048             *
049             * @return the primary key of this bookmarks folder
050             */
051            public long getPrimaryKey();
052    
053            /**
054             * Sets the primary key of this bookmarks folder
055             *
056             * @param pk the primary key of this bookmarks folder
057             */
058            public void setPrimaryKey(long pk);
059    
060            /**
061             * Gets the uuid of this bookmarks folder.
062             *
063             * @return the uuid of this bookmarks folder
064             */
065            @AutoEscape
066            public String getUuid();
067    
068            /**
069             * Sets the uuid of this bookmarks folder.
070             *
071             * @param uuid the uuid of this bookmarks folder
072             */
073            public void setUuid(String uuid);
074    
075            /**
076             * Gets the folder id of this bookmarks folder.
077             *
078             * @return the folder id of this bookmarks folder
079             */
080            public long getFolderId();
081    
082            /**
083             * Sets the folder id of this bookmarks folder.
084             *
085             * @param folderId the folder id of this bookmarks folder
086             */
087            public void setFolderId(long folderId);
088    
089            /**
090             * Gets the group id of this bookmarks folder.
091             *
092             * @return the group id of this bookmarks folder
093             */
094            public long getGroupId();
095    
096            /**
097             * Sets the group id of this bookmarks folder.
098             *
099             * @param groupId the group id of this bookmarks folder
100             */
101            public void setGroupId(long groupId);
102    
103            /**
104             * Gets the company id of this bookmarks folder.
105             *
106             * @return the company id of this bookmarks folder
107             */
108            public long getCompanyId();
109    
110            /**
111             * Sets the company id of this bookmarks folder.
112             *
113             * @param companyId the company id of this bookmarks folder
114             */
115            public void setCompanyId(long companyId);
116    
117            /**
118             * Gets the user id of this bookmarks folder.
119             *
120             * @return the user id of this bookmarks folder
121             */
122            public long getUserId();
123    
124            /**
125             * Sets the user id of this bookmarks folder.
126             *
127             * @param userId the user id of this bookmarks folder
128             */
129            public void setUserId(long userId);
130    
131            /**
132             * Gets the user uuid of this bookmarks folder.
133             *
134             * @return the user uuid of this bookmarks folder
135             * @throws SystemException if a system exception occurred
136             */
137            public String getUserUuid() throws SystemException;
138    
139            /**
140             * Sets the user uuid of this bookmarks folder.
141             *
142             * @param userUuid the user uuid of this bookmarks folder
143             */
144            public void setUserUuid(String userUuid);
145    
146            /**
147             * Gets the create date of this bookmarks folder.
148             *
149             * @return the create date of this bookmarks folder
150             */
151            public Date getCreateDate();
152    
153            /**
154             * Sets the create date of this bookmarks folder.
155             *
156             * @param createDate the create date of this bookmarks folder
157             */
158            public void setCreateDate(Date createDate);
159    
160            /**
161             * Gets the modified date of this bookmarks folder.
162             *
163             * @return the modified date of this bookmarks folder
164             */
165            public Date getModifiedDate();
166    
167            /**
168             * Sets the modified date of this bookmarks folder.
169             *
170             * @param modifiedDate the modified date of this bookmarks folder
171             */
172            public void setModifiedDate(Date modifiedDate);
173    
174            /**
175             * Gets the parent folder id of this bookmarks folder.
176             *
177             * @return the parent folder id of this bookmarks folder
178             */
179            public long getParentFolderId();
180    
181            /**
182             * Sets the parent folder id of this bookmarks folder.
183             *
184             * @param parentFolderId the parent folder id of this bookmarks folder
185             */
186            public void setParentFolderId(long parentFolderId);
187    
188            /**
189             * Gets the name of this bookmarks folder.
190             *
191             * @return the name of this bookmarks folder
192             */
193            @AutoEscape
194            public String getName();
195    
196            /**
197             * Sets the name of this bookmarks folder.
198             *
199             * @param name the name of this bookmarks folder
200             */
201            public void setName(String name);
202    
203            /**
204             * Gets the description of this bookmarks folder.
205             *
206             * @return the description of this bookmarks folder
207             */
208            @AutoEscape
209            public String getDescription();
210    
211            /**
212             * Sets the description of this bookmarks folder.
213             *
214             * @param description the description of this bookmarks folder
215             */
216            public void setDescription(String description);
217    
218            public boolean isNew();
219    
220            public void setNew(boolean n);
221    
222            public boolean isCachedModel();
223    
224            public void setCachedModel(boolean cachedModel);
225    
226            public boolean isEscapedModel();
227    
228            public void setEscapedModel(boolean escapedModel);
229    
230            public Serializable getPrimaryKeyObj();
231    
232            public ExpandoBridge getExpandoBridge();
233    
234            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
235    
236            public Object clone();
237    
238            public int compareTo(BookmarksFolder bookmarksFolder);
239    
240            public int hashCode();
241    
242            public BookmarksFolder toEscapedModel();
243    
244            public String toString();
245    
246            public String toXmlString();
247    }