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