001    /**
002     * Copyright (c) 2000-present 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 aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.bean.AutoEscape;
020    import com.liferay.portal.kernel.exception.PortalException;
021    import com.liferay.portal.kernel.trash.TrashHandler;
022    import com.liferay.portal.model.BaseModel;
023    import com.liferay.portal.model.CacheModel;
024    import com.liferay.portal.model.ContainerModel;
025    import com.liferay.portal.model.StagedGroupedModel;
026    import com.liferay.portal.model.TrashedModel;
027    import com.liferay.portal.model.WorkflowedModel;
028    import com.liferay.portal.service.ServiceContext;
029    
030    import com.liferay.portlet.expando.model.ExpandoBridge;
031    import com.liferay.portlet.trash.model.TrashEntry;
032    
033    import java.io.Serializable;
034    
035    import java.util.Date;
036    
037    /**
038     * 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.
039     *
040     * <p>
041     * 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}.
042     * </p>
043     *
044     * @author Brian Wing Shun Chan
045     * @see BookmarksFolder
046     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksFolderImpl
047     * @see com.liferay.portlet.bookmarks.model.impl.BookmarksFolderModelImpl
048     * @generated
049     */
050    @ProviderType
051    public interface BookmarksFolderModel extends BaseModel<BookmarksFolder>,
052            ContainerModel, StagedGroupedModel, TrashedModel, WorkflowedModel {
053            /*
054             * NOTE FOR DEVELOPERS:
055             *
056             * Never modify or reference this interface directly. All methods that expect a bookmarks folder model instance should use the {@link BookmarksFolder} interface instead.
057             */
058    
059            /**
060             * Returns the primary key of this bookmarks folder.
061             *
062             * @return the primary key of this bookmarks folder
063             */
064            public long getPrimaryKey();
065    
066            /**
067             * Sets the primary key of this bookmarks folder.
068             *
069             * @param primaryKey the primary key of this bookmarks folder
070             */
071            public void setPrimaryKey(long primaryKey);
072    
073            /**
074             * Returns the uuid of this bookmarks folder.
075             *
076             * @return the uuid of this bookmarks folder
077             */
078            @AutoEscape
079            @Override
080            public String getUuid();
081    
082            /**
083             * Sets the uuid of this bookmarks folder.
084             *
085             * @param uuid the uuid of this bookmarks folder
086             */
087            @Override
088            public void setUuid(String uuid);
089    
090            /**
091             * Returns the folder ID of this bookmarks folder.
092             *
093             * @return the folder ID of this bookmarks folder
094             */
095            public long getFolderId();
096    
097            /**
098             * Sets the folder ID of this bookmarks folder.
099             *
100             * @param folderId the folder ID of this bookmarks folder
101             */
102            public void setFolderId(long folderId);
103    
104            /**
105             * Returns the group ID of this bookmarks folder.
106             *
107             * @return the group ID of this bookmarks folder
108             */
109            @Override
110            public long getGroupId();
111    
112            /**
113             * Sets the group ID of this bookmarks folder.
114             *
115             * @param groupId the group ID of this bookmarks folder
116             */
117            @Override
118            public void setGroupId(long groupId);
119    
120            /**
121             * Returns the company ID of this bookmarks folder.
122             *
123             * @return the company ID of this bookmarks folder
124             */
125            @Override
126            public long getCompanyId();
127    
128            /**
129             * Sets the company ID of this bookmarks folder.
130             *
131             * @param companyId the company ID of this bookmarks folder
132             */
133            @Override
134            public void setCompanyId(long companyId);
135    
136            /**
137             * Returns the user ID of this bookmarks folder.
138             *
139             * @return the user ID of this bookmarks folder
140             */
141            @Override
142            public long getUserId();
143    
144            /**
145             * Sets the user ID of this bookmarks folder.
146             *
147             * @param userId the user ID of this bookmarks folder
148             */
149            @Override
150            public void setUserId(long userId);
151    
152            /**
153             * Returns the user uuid of this bookmarks folder.
154             *
155             * @return the user uuid of this bookmarks folder
156             */
157            @Override
158            public String getUserUuid();
159    
160            /**
161             * Sets the user uuid of this bookmarks folder.
162             *
163             * @param userUuid the user uuid of this bookmarks folder
164             */
165            @Override
166            public void setUserUuid(String userUuid);
167    
168            /**
169             * Returns the user name of this bookmarks folder.
170             *
171             * @return the user name of this bookmarks folder
172             */
173            @AutoEscape
174            @Override
175            public String getUserName();
176    
177            /**
178             * Sets the user name of this bookmarks folder.
179             *
180             * @param userName the user name of this bookmarks folder
181             */
182            @Override
183            public void setUserName(String userName);
184    
185            /**
186             * Returns the create date of this bookmarks folder.
187             *
188             * @return the create date of this bookmarks folder
189             */
190            @Override
191            public Date getCreateDate();
192    
193            /**
194             * Sets the create date of this bookmarks folder.
195             *
196             * @param createDate the create date of this bookmarks folder
197             */
198            @Override
199            public void setCreateDate(Date createDate);
200    
201            /**
202             * Returns the modified date of this bookmarks folder.
203             *
204             * @return the modified date of this bookmarks folder
205             */
206            @Override
207            public Date getModifiedDate();
208    
209            /**
210             * Sets the modified date of this bookmarks folder.
211             *
212             * @param modifiedDate the modified date of this bookmarks folder
213             */
214            @Override
215            public void setModifiedDate(Date modifiedDate);
216    
217            /**
218             * Returns the resource block ID of this bookmarks folder.
219             *
220             * @return the resource block ID of this bookmarks folder
221             */
222            public long getResourceBlockId();
223    
224            /**
225             * Sets the resource block ID of this bookmarks folder.
226             *
227             * @param resourceBlockId the resource block ID of this bookmarks folder
228             */
229            public void setResourceBlockId(long resourceBlockId);
230    
231            /**
232             * Returns the parent folder ID of this bookmarks folder.
233             *
234             * @return the parent folder ID of this bookmarks folder
235             */
236            public long getParentFolderId();
237    
238            /**
239             * Sets the parent folder ID of this bookmarks folder.
240             *
241             * @param parentFolderId the parent folder ID of this bookmarks folder
242             */
243            public void setParentFolderId(long parentFolderId);
244    
245            /**
246             * Returns the tree path of this bookmarks folder.
247             *
248             * @return the tree path of this bookmarks folder
249             */
250            @AutoEscape
251            public String getTreePath();
252    
253            /**
254             * Sets the tree path of this bookmarks folder.
255             *
256             * @param treePath the tree path of this bookmarks folder
257             */
258            public void setTreePath(String treePath);
259    
260            /**
261             * Returns the name of this bookmarks folder.
262             *
263             * @return the name of this bookmarks folder
264             */
265            @AutoEscape
266            public String getName();
267    
268            /**
269             * Sets the name of this bookmarks folder.
270             *
271             * @param name the name of this bookmarks folder
272             */
273            public void setName(String name);
274    
275            /**
276             * Returns the description of this bookmarks folder.
277             *
278             * @return the description of this bookmarks folder
279             */
280            @AutoEscape
281            public String getDescription();
282    
283            /**
284             * Sets the description of this bookmarks folder.
285             *
286             * @param description the description of this bookmarks folder
287             */
288            public void setDescription(String description);
289    
290            /**
291             * Returns the status of this bookmarks folder.
292             *
293             * @return the status of this bookmarks folder
294             */
295            @Override
296            public int getStatus();
297    
298            /**
299             * Sets the status of this bookmarks folder.
300             *
301             * @param status the status of this bookmarks folder
302             */
303            @Override
304            public void setStatus(int status);
305    
306            /**
307             * Returns the status by user ID of this bookmarks folder.
308             *
309             * @return the status by user ID of this bookmarks folder
310             */
311            @Override
312            public long getStatusByUserId();
313    
314            /**
315             * Sets the status by user ID of this bookmarks folder.
316             *
317             * @param statusByUserId the status by user ID of this bookmarks folder
318             */
319            @Override
320            public void setStatusByUserId(long statusByUserId);
321    
322            /**
323             * Returns the status by user uuid of this bookmarks folder.
324             *
325             * @return the status by user uuid of this bookmarks folder
326             */
327            @Override
328            public String getStatusByUserUuid();
329    
330            /**
331             * Sets the status by user uuid of this bookmarks folder.
332             *
333             * @param statusByUserUuid the status by user uuid of this bookmarks folder
334             */
335            @Override
336            public void setStatusByUserUuid(String statusByUserUuid);
337    
338            /**
339             * Returns the status by user name of this bookmarks folder.
340             *
341             * @return the status by user name of this bookmarks folder
342             */
343            @AutoEscape
344            @Override
345            public String getStatusByUserName();
346    
347            /**
348             * Sets the status by user name of this bookmarks folder.
349             *
350             * @param statusByUserName the status by user name of this bookmarks folder
351             */
352            @Override
353            public void setStatusByUserName(String statusByUserName);
354    
355            /**
356             * Returns the status date of this bookmarks folder.
357             *
358             * @return the status date of this bookmarks folder
359             */
360            @Override
361            public Date getStatusDate();
362    
363            /**
364             * Sets the status date of this bookmarks folder.
365             *
366             * @param statusDate the status date of this bookmarks folder
367             */
368            @Override
369            public void setStatusDate(Date statusDate);
370    
371            /**
372             * Returns the trash entry created when this bookmarks folder was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this bookmarks folder.
373             *
374             * @return the trash entry created when this bookmarks folder was moved to the Recycle Bin
375             */
376            @Override
377            public TrashEntry getTrashEntry() throws PortalException;
378    
379            /**
380             * Returns the class primary key of the trash entry for this bookmarks folder.
381             *
382             * @return the class primary key of the trash entry for this bookmarks folder
383             */
384            @Override
385            public long getTrashEntryClassPK();
386    
387            /**
388             * Returns the trash handler for this bookmarks folder.
389             *
390             * @return the trash handler for this bookmarks folder
391             */
392            @Override
393            public TrashHandler getTrashHandler();
394    
395            /**
396             * Returns <code>true</code> if this bookmarks folder is in the Recycle Bin.
397             *
398             * @return <code>true</code> if this bookmarks folder is in the Recycle Bin; <code>false</code> otherwise
399             */
400            @Override
401            public boolean isInTrash();
402    
403            /**
404             * Returns <code>true</code> if the parent of this bookmarks folder is in the Recycle Bin.
405             *
406             * @return <code>true</code> if the parent of this bookmarks folder is in the Recycle Bin; <code>false</code> otherwise
407             */
408            @Override
409            public boolean isInTrashContainer();
410    
411            @Override
412            public boolean isInTrashExplicitly();
413    
414            @Override
415            public boolean isInTrashImplicitly();
416    
417            /**
418             * @deprecated As of 6.1.0, replaced by {@link #isApproved()}
419             */
420            @Deprecated
421            @Override
422            public boolean getApproved();
423    
424            /**
425             * Returns <code>true</code> if this bookmarks folder is approved.
426             *
427             * @return <code>true</code> if this bookmarks folder is approved; <code>false</code> otherwise
428             */
429            @Override
430            public boolean isApproved();
431    
432            /**
433             * Returns <code>true</code> if this bookmarks folder is denied.
434             *
435             * @return <code>true</code> if this bookmarks folder is denied; <code>false</code> otherwise
436             */
437            @Override
438            public boolean isDenied();
439    
440            /**
441             * Returns <code>true</code> if this bookmarks folder is a draft.
442             *
443             * @return <code>true</code> if this bookmarks folder is a draft; <code>false</code> otherwise
444             */
445            @Override
446            public boolean isDraft();
447    
448            /**
449             * Returns <code>true</code> if this bookmarks folder is expired.
450             *
451             * @return <code>true</code> if this bookmarks folder is expired; <code>false</code> otherwise
452             */
453            @Override
454            public boolean isExpired();
455    
456            /**
457             * Returns <code>true</code> if this bookmarks folder is inactive.
458             *
459             * @return <code>true</code> if this bookmarks folder is inactive; <code>false</code> otherwise
460             */
461            @Override
462            public boolean isInactive();
463    
464            /**
465             * Returns <code>true</code> if this bookmarks folder is incomplete.
466             *
467             * @return <code>true</code> if this bookmarks folder is incomplete; <code>false</code> otherwise
468             */
469            @Override
470            public boolean isIncomplete();
471    
472            /**
473             * Returns <code>true</code> if this bookmarks folder is pending.
474             *
475             * @return <code>true</code> if this bookmarks folder is pending; <code>false</code> otherwise
476             */
477            @Override
478            public boolean isPending();
479    
480            /**
481             * Returns <code>true</code> if this bookmarks folder is scheduled.
482             *
483             * @return <code>true</code> if this bookmarks folder is scheduled; <code>false</code> otherwise
484             */
485            @Override
486            public boolean isScheduled();
487    
488            /**
489             * Returns the container model ID of this bookmarks folder.
490             *
491             * @return the container model ID of this bookmarks folder
492             */
493            @Override
494            public long getContainerModelId();
495    
496            /**
497             * Sets the container model ID of this bookmarks folder.
498             *
499             * @param containerModelId the container model ID of this bookmarks folder
500             */
501            @Override
502            public void setContainerModelId(long containerModelId);
503    
504            /**
505             * Returns the container name of this bookmarks folder.
506             *
507             * @return the container name of this bookmarks folder
508             */
509            @Override
510            public String getContainerModelName();
511    
512            /**
513             * Returns the parent container model ID of this bookmarks folder.
514             *
515             * @return the parent container model ID of this bookmarks folder
516             */
517            @Override
518            public long getParentContainerModelId();
519    
520            /**
521             * Sets the parent container model ID of this bookmarks folder.
522             *
523             * @param parentContainerModelId the parent container model ID of this bookmarks folder
524             */
525            @Override
526            public void setParentContainerModelId(long parentContainerModelId);
527    
528            @Override
529            public boolean isNew();
530    
531            @Override
532            public void setNew(boolean n);
533    
534            @Override
535            public boolean isCachedModel();
536    
537            @Override
538            public void setCachedModel(boolean cachedModel);
539    
540            @Override
541            public boolean isEscapedModel();
542    
543            @Override
544            public Serializable getPrimaryKeyObj();
545    
546            @Override
547            public void setPrimaryKeyObj(Serializable primaryKeyObj);
548    
549            @Override
550            public ExpandoBridge getExpandoBridge();
551    
552            @Override
553            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
554    
555            @Override
556            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
557    
558            @Override
559            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
560    
561            @Override
562            public Object clone();
563    
564            @Override
565            public int compareTo(BookmarksFolder bookmarksFolder);
566    
567            @Override
568            public int hashCode();
569    
570            @Override
571            public CacheModel<BookmarksFolder> toCacheModel();
572    
573            @Override
574            public BookmarksFolder toEscapedModel();
575    
576            @Override
577            public BookmarksFolder toUnescapedModel();
578    
579            @Override
580            public String toString();
581    
582            @Override
583            public String toXmlString();
584    }