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