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