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.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.ContainerModel;
022    import com.liferay.portal.model.GroupedModel;
023    import com.liferay.portal.model.StagedModel;
024    import com.liferay.portal.model.WorkflowedModel;
025    import com.liferay.portal.service.ServiceContext;
026    
027    import com.liferay.portlet.expando.model.ExpandoBridge;
028    
029    import java.io.Serializable;
030    
031    import java.util.Date;
032    
033    /**
034     * 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.
035     *
036     * <p>
037     * 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}.
038     * </p>
039     *
040     * @author Brian Wing Shun Chan
041     * @see BookmarksFolder
042     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksFolderImpl
043     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl
044     * @generated
045     */
046    public interface BookmarksFolderModel extends BaseModel<BookmarksFolder>,
047            ContainerModel, GroupedModel, StagedModel, WorkflowedModel {
048            /*
049             * NOTE FOR DEVELOPERS:
050             *
051             * Never modify or reference this interface directly. All methods that expect a bookmarks folder model instance should use the {@link BookmarksFolder} interface instead.
052             */
053    
054            /**
055             * Returns the primary key of this bookmarks folder.
056             *
057             * @return the primary key of this bookmarks folder
058             */
059            public long getPrimaryKey();
060    
061            /**
062             * Sets the primary key of this bookmarks folder.
063             *
064             * @param primaryKey the primary key of this bookmarks folder
065             */
066            public void setPrimaryKey(long primaryKey);
067    
068            /**
069             * Returns the uuid of this bookmarks folder.
070             *
071             * @return the uuid of this bookmarks folder
072             */
073            @AutoEscape
074            public String getUuid();
075    
076            /**
077             * Sets the uuid of this bookmarks folder.
078             *
079             * @param uuid the uuid of this bookmarks folder
080             */
081            public void setUuid(String uuid);
082    
083            /**
084             * Returns the folder ID of this bookmarks folder.
085             *
086             * @return the folder ID of this bookmarks folder
087             */
088            public long getFolderId();
089    
090            /**
091             * Sets the folder ID of this bookmarks folder.
092             *
093             * @param folderId the folder ID of this bookmarks folder
094             */
095            public void setFolderId(long folderId);
096    
097            /**
098             * Returns the group ID of this bookmarks folder.
099             *
100             * @return the group ID of this bookmarks folder
101             */
102            public long getGroupId();
103    
104            /**
105             * Sets the group ID of this bookmarks folder.
106             *
107             * @param groupId the group ID of this bookmarks folder
108             */
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this bookmarks folder.
113             *
114             * @return the company ID of this bookmarks folder
115             */
116            public long getCompanyId();
117    
118            /**
119             * Sets the company ID of this bookmarks folder.
120             *
121             * @param companyId the company ID of this bookmarks folder
122             */
123            public void setCompanyId(long companyId);
124    
125            /**
126             * Returns the user ID of this bookmarks folder.
127             *
128             * @return the user ID of this bookmarks folder
129             */
130            public long getUserId();
131    
132            /**
133             * Sets the user ID of this bookmarks folder.
134             *
135             * @param userId the user ID of this bookmarks folder
136             */
137            public void setUserId(long userId);
138    
139            /**
140             * Returns the user uuid of this bookmarks folder.
141             *
142             * @return the user uuid of this bookmarks folder
143             * @throws SystemException if a system exception occurred
144             */
145            public String getUserUuid() throws SystemException;
146    
147            /**
148             * Sets the user uuid of this bookmarks folder.
149             *
150             * @param userUuid the user uuid of this bookmarks folder
151             */
152            public void setUserUuid(String userUuid);
153    
154            /**
155             * Returns the user name of this bookmarks folder.
156             *
157             * @return the user name of this bookmarks folder
158             */
159            @AutoEscape
160            public String getUserName();
161    
162            /**
163             * Sets the user name of this bookmarks folder.
164             *
165             * @param userName the user name of this bookmarks folder
166             */
167            public void setUserName(String userName);
168    
169            /**
170             * Returns the create date of this bookmarks folder.
171             *
172             * @return the create date of this bookmarks folder
173             */
174            public Date getCreateDate();
175    
176            /**
177             * Sets the create date of this bookmarks folder.
178             *
179             * @param createDate the create date of this bookmarks folder
180             */
181            public void setCreateDate(Date createDate);
182    
183            /**
184             * Returns the modified date of this bookmarks folder.
185             *
186             * @return the modified date of this bookmarks folder
187             */
188            public Date getModifiedDate();
189    
190            /**
191             * Sets the modified date of this bookmarks folder.
192             *
193             * @param modifiedDate the modified date of this bookmarks folder
194             */
195            public void setModifiedDate(Date modifiedDate);
196    
197            /**
198             * Returns the resource block ID of this bookmarks folder.
199             *
200             * @return the resource block ID of this bookmarks folder
201             */
202            public long getResourceBlockId();
203    
204            /**
205             * Sets the resource block ID of this bookmarks folder.
206             *
207             * @param resourceBlockId the resource block ID of this bookmarks folder
208             */
209            public void setResourceBlockId(long resourceBlockId);
210    
211            /**
212             * Returns the parent folder ID of this bookmarks folder.
213             *
214             * @return the parent folder ID of this bookmarks folder
215             */
216            public long getParentFolderId();
217    
218            /**
219             * Sets the parent folder ID of this bookmarks folder.
220             *
221             * @param parentFolderId the parent folder ID of this bookmarks folder
222             */
223            public void setParentFolderId(long parentFolderId);
224    
225            /**
226             * Returns the name of this bookmarks folder.
227             *
228             * @return the name of this bookmarks folder
229             */
230            @AutoEscape
231            public String getName();
232    
233            /**
234             * Sets the name of this bookmarks folder.
235             *
236             * @param name the name of this bookmarks folder
237             */
238            public void setName(String name);
239    
240            /**
241             * Returns the description of this bookmarks folder.
242             *
243             * @return the description of this bookmarks folder
244             */
245            @AutoEscape
246            public String getDescription();
247    
248            /**
249             * Sets the description of this bookmarks folder.
250             *
251             * @param description the description of this bookmarks folder
252             */
253            public void setDescription(String description);
254    
255            /**
256             * Returns the status of this bookmarks folder.
257             *
258             * @return the status of this bookmarks folder
259             */
260            public int getStatus();
261    
262            /**
263             * Sets the status of this bookmarks folder.
264             *
265             * @param status the status of this bookmarks folder
266             */
267            public void setStatus(int status);
268    
269            /**
270             * Returns the status by user ID of this bookmarks folder.
271             *
272             * @return the status by user ID of this bookmarks folder
273             */
274            public long getStatusByUserId();
275    
276            /**
277             * Sets the status by user ID of this bookmarks folder.
278             *
279             * @param statusByUserId the status by user ID of this bookmarks folder
280             */
281            public void setStatusByUserId(long statusByUserId);
282    
283            /**
284             * Returns the status by user uuid of this bookmarks folder.
285             *
286             * @return the status by user uuid of this bookmarks folder
287             * @throws SystemException if a system exception occurred
288             */
289            public String getStatusByUserUuid() throws SystemException;
290    
291            /**
292             * Sets the status by user uuid of this bookmarks folder.
293             *
294             * @param statusByUserUuid the status by user uuid of this bookmarks folder
295             */
296            public void setStatusByUserUuid(String statusByUserUuid);
297    
298            /**
299             * Returns the status by user name of this bookmarks folder.
300             *
301             * @return the status by user name of this bookmarks folder
302             */
303            @AutoEscape
304            public String getStatusByUserName();
305    
306            /**
307             * Sets the status by user name of this bookmarks folder.
308             *
309             * @param statusByUserName the status by user name of this bookmarks folder
310             */
311            public void setStatusByUserName(String statusByUserName);
312    
313            /**
314             * Returns the status date of this bookmarks folder.
315             *
316             * @return the status date of this bookmarks folder
317             */
318            public Date getStatusDate();
319    
320            /**
321             * Sets the status date of this bookmarks folder.
322             *
323             * @param statusDate the status date of this bookmarks folder
324             */
325            public void setStatusDate(Date statusDate);
326    
327            /**
328             * @deprecated Renamed to {@link #isApproved()}
329             */
330            public boolean getApproved();
331    
332            /**
333             * Returns <code>true</code> if this bookmarks folder is approved.
334             *
335             * @return <code>true</code> if this bookmarks folder is approved; <code>false</code> otherwise
336             */
337            public boolean isApproved();
338    
339            /**
340             * Returns <code>true</code> if this bookmarks folder is denied.
341             *
342             * @return <code>true</code> if this bookmarks folder is denied; <code>false</code> otherwise
343             */
344            public boolean isDenied();
345    
346            /**
347             * Returns <code>true</code> if this bookmarks folder is a draft.
348             *
349             * @return <code>true</code> if this bookmarks folder is a draft; <code>false</code> otherwise
350             */
351            public boolean isDraft();
352    
353            /**
354             * Returns <code>true</code> if this bookmarks folder is expired.
355             *
356             * @return <code>true</code> if this bookmarks folder is expired; <code>false</code> otherwise
357             */
358            public boolean isExpired();
359    
360            /**
361             * Returns <code>true</code> if this bookmarks folder is inactive.
362             *
363             * @return <code>true</code> if this bookmarks folder is inactive; <code>false</code> otherwise
364             */
365            public boolean isInactive();
366    
367            /**
368             * Returns <code>true</code> if this bookmarks folder is incomplete.
369             *
370             * @return <code>true</code> if this bookmarks folder is incomplete; <code>false</code> otherwise
371             */
372            public boolean isIncomplete();
373    
374            /**
375             * Returns <code>true</code> if this bookmarks folder is in the Recycle Bin.
376             *
377             * @return <code>true</code> if this bookmarks folder is in the Recycle Bin; <code>false</code> otherwise
378             */
379            public boolean isInTrash();
380    
381            /**
382             * Returns <code>true</code> if this bookmarks folder is pending.
383             *
384             * @return <code>true</code> if this bookmarks folder is pending; <code>false</code> otherwise
385             */
386            public boolean isPending();
387    
388            /**
389             * Returns <code>true</code> if this bookmarks folder is scheduled.
390             *
391             * @return <code>true</code> if this bookmarks folder is scheduled; <code>false</code> otherwise
392             */
393            public boolean isScheduled();
394    
395            /**
396             * Returns the container model ID of this bookmarks folder.
397             *
398             * @return the container model ID of this bookmarks folder
399             */
400            public long getContainerModelId();
401    
402            /**
403             * Sets the container model ID of this bookmarks folder.
404             *
405             * @param container model ID of this bookmarks folder
406             */
407            public void setContainerModelId(long containerModelId);
408    
409            /**
410             * Returns the container name of this bookmarks folder.
411             *
412             * @return the container name of this bookmarks folder
413             */
414            public String getContainerModelName();
415    
416            /**
417             * Returns the parent container model ID of this bookmarks folder.
418             *
419             * @return the parent container model ID of this bookmarks folder
420             */
421            public long getParentContainerModelId();
422    
423            /**
424             * Sets the parent container model ID of this bookmarks folder.
425             *
426             * @param parent container model ID of this bookmarks folder
427             */
428            public void setParentContainerModelId(long parentContainerModelId);
429    
430            public boolean isNew();
431    
432            public void setNew(boolean n);
433    
434            public boolean isCachedModel();
435    
436            public void setCachedModel(boolean cachedModel);
437    
438            public boolean isEscapedModel();
439    
440            public Serializable getPrimaryKeyObj();
441    
442            public void setPrimaryKeyObj(Serializable primaryKeyObj);
443    
444            public ExpandoBridge getExpandoBridge();
445    
446            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
447    
448            public Object clone();
449    
450            public int compareTo(BookmarksFolder bookmarksFolder);
451    
452            public int hashCode();
453    
454            public CacheModel<BookmarksFolder> toCacheModel();
455    
456            public BookmarksFolder toEscapedModel();
457    
458            public BookmarksFolder toUnescapedModel();
459    
460            public String toString();
461    
462            public String toXmlString();
463    }