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.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 BookmarksEntry service. Represents a row in the "BookmarksEntry" 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.BookmarksEntryModelImpl} 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.BookmarksEntryImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see BookmarksEntry
039     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksEntryImpl
040     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksEntryModelImpl
041     * @generated
042     */
043    public interface BookmarksEntryModel extends BaseModel<BookmarksEntry>,
044            GroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a bookmarks entry model instance should use the {@link BookmarksEntry} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this bookmarks entry.
053             *
054             * @return the primary key of this bookmarks entry
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this bookmarks entry.
060             *
061             * @param primaryKey the primary key of this bookmarks entry
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the uuid of this bookmarks entry.
067             *
068             * @return the uuid of this bookmarks entry
069             */
070            @AutoEscape
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this bookmarks entry.
075             *
076             * @param uuid the uuid of this bookmarks entry
077             */
078            public void setUuid(String uuid);
079    
080            /**
081             * Returns the entry ID of this bookmarks entry.
082             *
083             * @return the entry ID of this bookmarks entry
084             */
085            public long getEntryId();
086    
087            /**
088             * Sets the entry ID of this bookmarks entry.
089             *
090             * @param entryId the entry ID of this bookmarks entry
091             */
092            public void setEntryId(long entryId);
093    
094            /**
095             * Returns the group ID of this bookmarks entry.
096             *
097             * @return the group ID of this bookmarks entry
098             */
099            public long getGroupId();
100    
101            /**
102             * Sets the group ID of this bookmarks entry.
103             *
104             * @param groupId the group ID of this bookmarks entry
105             */
106            public void setGroupId(long groupId);
107    
108            /**
109             * Returns the company ID of this bookmarks entry.
110             *
111             * @return the company ID of this bookmarks entry
112             */
113            public long getCompanyId();
114    
115            /**
116             * Sets the company ID of this bookmarks entry.
117             *
118             * @param companyId the company ID of this bookmarks entry
119             */
120            public void setCompanyId(long companyId);
121    
122            /**
123             * Returns the user ID of this bookmarks entry.
124             *
125             * @return the user ID of this bookmarks entry
126             */
127            public long getUserId();
128    
129            /**
130             * Sets the user ID of this bookmarks entry.
131             *
132             * @param userId the user ID of this bookmarks entry
133             */
134            public void setUserId(long userId);
135    
136            /**
137             * Returns the user uuid of this bookmarks entry.
138             *
139             * @return the user uuid of this bookmarks entry
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 entry.
146             *
147             * @param userUuid the user uuid of this bookmarks entry
148             */
149            public void setUserUuid(String userUuid);
150    
151            /**
152             * Returns the user name of this bookmarks entry.
153             *
154             * @return the user name of this bookmarks entry
155             */
156            @AutoEscape
157            public String getUserName();
158    
159            /**
160             * Sets the user name of this bookmarks entry.
161             *
162             * @param userName the user name of this bookmarks entry
163             */
164            public void setUserName(String userName);
165    
166            /**
167             * Returns the create date of this bookmarks entry.
168             *
169             * @return the create date of this bookmarks entry
170             */
171            public Date getCreateDate();
172    
173            /**
174             * Sets the create date of this bookmarks entry.
175             *
176             * @param createDate the create date of this bookmarks entry
177             */
178            public void setCreateDate(Date createDate);
179    
180            /**
181             * Returns the modified date of this bookmarks entry.
182             *
183             * @return the modified date of this bookmarks entry
184             */
185            public Date getModifiedDate();
186    
187            /**
188             * Sets the modified date of this bookmarks entry.
189             *
190             * @param modifiedDate the modified date of this bookmarks entry
191             */
192            public void setModifiedDate(Date modifiedDate);
193    
194            /**
195             * Returns the resource block ID of this bookmarks entry.
196             *
197             * @return the resource block ID of this bookmarks entry
198             */
199            public long getResourceBlockId();
200    
201            /**
202             * Sets the resource block ID of this bookmarks entry.
203             *
204             * @param resourceBlockId the resource block ID of this bookmarks entry
205             */
206            public void setResourceBlockId(long resourceBlockId);
207    
208            /**
209             * Returns the folder ID of this bookmarks entry.
210             *
211             * @return the folder ID of this bookmarks entry
212             */
213            public long getFolderId();
214    
215            /**
216             * Sets the folder ID of this bookmarks entry.
217             *
218             * @param folderId the folder ID of this bookmarks entry
219             */
220            public void setFolderId(long folderId);
221    
222            /**
223             * Returns the name of this bookmarks entry.
224             *
225             * @return the name of this bookmarks entry
226             */
227            @AutoEscape
228            public String getName();
229    
230            /**
231             * Sets the name of this bookmarks entry.
232             *
233             * @param name the name of this bookmarks entry
234             */
235            public void setName(String name);
236    
237            /**
238             * Returns the url of this bookmarks entry.
239             *
240             * @return the url of this bookmarks entry
241             */
242            @AutoEscape
243            public String getUrl();
244    
245            /**
246             * Sets the url of this bookmarks entry.
247             *
248             * @param url the url of this bookmarks entry
249             */
250            public void setUrl(String url);
251    
252            /**
253             * Returns the description of this bookmarks entry.
254             *
255             * @return the description of this bookmarks entry
256             */
257            @AutoEscape
258            public String getDescription();
259    
260            /**
261             * Sets the description of this bookmarks entry.
262             *
263             * @param description the description of this bookmarks entry
264             */
265            public void setDescription(String description);
266    
267            /**
268             * Returns the visits of this bookmarks entry.
269             *
270             * @return the visits of this bookmarks entry
271             */
272            public int getVisits();
273    
274            /**
275             * Sets the visits of this bookmarks entry.
276             *
277             * @param visits the visits of this bookmarks entry
278             */
279            public void setVisits(int visits);
280    
281            /**
282             * Returns the priority of this bookmarks entry.
283             *
284             * @return the priority of this bookmarks entry
285             */
286            public int getPriority();
287    
288            /**
289             * Sets the priority of this bookmarks entry.
290             *
291             * @param priority the priority of this bookmarks entry
292             */
293            public void setPriority(int priority);
294    
295            public boolean isNew();
296    
297            public void setNew(boolean n);
298    
299            public boolean isCachedModel();
300    
301            public void setCachedModel(boolean cachedModel);
302    
303            public boolean isEscapedModel();
304    
305            public Serializable getPrimaryKeyObj();
306    
307            public void setPrimaryKeyObj(Serializable primaryKeyObj);
308    
309            public ExpandoBridge getExpandoBridge();
310    
311            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
312    
313            public Object clone();
314    
315            public int compareTo(BookmarksEntry bookmarksEntry);
316    
317            public int hashCode();
318    
319            public CacheModel<BookmarksEntry> toCacheModel();
320    
321            public BookmarksEntry toEscapedModel();
322    
323            public BookmarksEntry toUnescapedModel();
324    
325            public String toString();
326    
327            public String toXmlString();
328    }