001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.documentlibrary.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.model.ContainerModel;
022    import com.liferay.portal.model.GroupedModel;
023    import com.liferay.portal.model.StagedModel;
024    import com.liferay.portal.model.WorkflowedModel;
025    import com.liferay.portal.service.ServiceContext;
026    
027    import com.liferay.portlet.expando.model.ExpandoBridge;
028    
029    import java.io.Serializable;
030    
031    import java.util.Date;
032    
033    /**
034     * The base model interface for the DLFolder service. Represents a row in the "DLFolder" database table, with each column mapped to a property of this class.
035     *
036     * <p>
037     * This interface and its corresponding implementation {@link com.liferay.portlet.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}.
038     * </p>
039     *
040     * @author Brian Wing Shun Chan
041     * @see DLFolder
042     * @see com.liferay.portlet.documentlibrary.model.impl.DLFolderImpl
043     * @see com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl
044     * @generated
045     */
046    public interface DLFolderModel extends BaseModel<DLFolder>, ContainerModel,
047            GroupedModel, StagedModel, WorkflowedModel {
048            /*
049             * NOTE FOR DEVELOPERS:
050             *
051             * Never modify or reference this interface directly. All methods that expect a document library folder model instance should use the {@link DLFolder} interface instead.
052             */
053    
054            /**
055             * Returns the primary key of this document library folder.
056             *
057             * @return the primary key of this document library folder
058             */
059            public long getPrimaryKey();
060    
061            /**
062             * Sets the primary key of this document library folder.
063             *
064             * @param primaryKey the primary key of this document library folder
065             */
066            public void setPrimaryKey(long primaryKey);
067    
068            /**
069             * Returns the uuid of this document library folder.
070             *
071             * @return the uuid of this document library folder
072             */
073            @AutoEscape
074            public String getUuid();
075    
076            /**
077             * Sets the uuid of this document library folder.
078             *
079             * @param uuid the uuid of this document library folder
080             */
081            public void setUuid(String uuid);
082    
083            /**
084             * Returns the folder ID of this document library folder.
085             *
086             * @return the folder ID of this document library folder
087             */
088            public long getFolderId();
089    
090            /**
091             * Sets the folder ID of this document library folder.
092             *
093             * @param folderId the folder ID of this document library folder
094             */
095            public void setFolderId(long folderId);
096    
097            /**
098             * Returns the group ID of this document library folder.
099             *
100             * @return the group ID of this document library folder
101             */
102            public long getGroupId();
103    
104            /**
105             * Sets the group ID of this document library folder.
106             *
107             * @param groupId the group ID of this document library folder
108             */
109            public void setGroupId(long groupId);
110    
111            /**
112             * Returns the company ID of this document library folder.
113             *
114             * @return the company ID of this document library folder
115             */
116            public long getCompanyId();
117    
118            /**
119             * Sets the company ID of this document library folder.
120             *
121             * @param companyId the company ID of this document library folder
122             */
123            public void setCompanyId(long companyId);
124    
125            /**
126             * Returns the user ID of this document library folder.
127             *
128             * @return the user ID of this document library folder
129             */
130            public long getUserId();
131    
132            /**
133             * Sets the user ID of this document library folder.
134             *
135             * @param userId the user ID of this document library folder
136             */
137            public void setUserId(long userId);
138    
139            /**
140             * Returns the user uuid of this document library folder.
141             *
142             * @return the user uuid of this document library folder
143             * @throws SystemException if a system exception occurred
144             */
145            public String getUserUuid() throws SystemException;
146    
147            /**
148             * Sets the user uuid of this document library folder.
149             *
150             * @param userUuid the user uuid of this document library folder
151             */
152            public void setUserUuid(String userUuid);
153    
154            /**
155             * Returns the user name of this document library folder.
156             *
157             * @return the user name of this document library folder
158             */
159            @AutoEscape
160            public String getUserName();
161    
162            /**
163             * Sets the user name of this document library folder.
164             *
165             * @param userName the user name of this document library folder
166             */
167            public void setUserName(String userName);
168    
169            /**
170             * Returns the create date of this document library folder.
171             *
172             * @return the create date of this document library folder
173             */
174            public Date getCreateDate();
175    
176            /**
177             * Sets the create date of this document library folder.
178             *
179             * @param createDate the create date of this document library folder
180             */
181            public void setCreateDate(Date createDate);
182    
183            /**
184             * Returns the modified date of this document library folder.
185             *
186             * @return the modified date of this document library folder
187             */
188            public Date getModifiedDate();
189    
190            /**
191             * Sets the modified date of this document library folder.
192             *
193             * @param modifiedDate the modified date of this document library folder
194             */
195            public void setModifiedDate(Date modifiedDate);
196    
197            /**
198             * Returns the repository ID of this document library folder.
199             *
200             * @return the repository ID of this document library folder
201             */
202            public long getRepositoryId();
203    
204            /**
205             * Sets the repository ID of this document library folder.
206             *
207             * @param repositoryId the repository ID of this document library folder
208             */
209            public void setRepositoryId(long repositoryId);
210    
211            /**
212             * Returns the mount point of this document library folder.
213             *
214             * @return the mount point of this document library folder
215             */
216            public boolean getMountPoint();
217    
218            /**
219             * Returns <code>true</code> if this document library folder is mount point.
220             *
221             * @return <code>true</code> if this document library folder is mount point; <code>false</code> otherwise
222             */
223            public boolean isMountPoint();
224    
225            /**
226             * Sets whether this document library folder is mount point.
227             *
228             * @param mountPoint the mount point of this document library folder
229             */
230            public void setMountPoint(boolean mountPoint);
231    
232            /**
233             * Returns the parent folder ID of this document library folder.
234             *
235             * @return the parent folder ID of this document library folder
236             */
237            public long getParentFolderId();
238    
239            /**
240             * Sets the parent folder ID of this document library folder.
241             *
242             * @param parentFolderId the parent folder ID of this document library folder
243             */
244            public void setParentFolderId(long parentFolderId);
245    
246            /**
247             * Returns the name of this document library folder.
248             *
249             * @return the name of this document library folder
250             */
251            @AutoEscape
252            public String getName();
253    
254            /**
255             * Sets the name of this document library folder.
256             *
257             * @param name the name of this document library folder
258             */
259            public void setName(String name);
260    
261            /**
262             * Returns the description of this document library folder.
263             *
264             * @return the description of this document library folder
265             */
266            @AutoEscape
267            public String getDescription();
268    
269            /**
270             * Sets the description of this document library folder.
271             *
272             * @param description the description of this document library folder
273             */
274            public void setDescription(String description);
275    
276            /**
277             * Returns the last post date of this document library folder.
278             *
279             * @return the last post date of this document library folder
280             */
281            public Date getLastPostDate();
282    
283            /**
284             * Sets the last post date of this document library folder.
285             *
286             * @param lastPostDate the last post date of this document library folder
287             */
288            public void setLastPostDate(Date lastPostDate);
289    
290            /**
291             * Returns the default file entry type ID of this document library folder.
292             *
293             * @return the default file entry type ID of this document library folder
294             */
295            public long getDefaultFileEntryTypeId();
296    
297            /**
298             * Sets the default file entry type ID of this document library folder.
299             *
300             * @param defaultFileEntryTypeId the default file entry type ID of this document library folder
301             */
302            public void setDefaultFileEntryTypeId(long defaultFileEntryTypeId);
303    
304            /**
305             * Returns the hidden of this document library folder.
306             *
307             * @return the hidden of this document library folder
308             */
309            public boolean getHidden();
310    
311            /**
312             * Returns <code>true</code> if this document library folder is hidden.
313             *
314             * @return <code>true</code> if this document library folder is hidden; <code>false</code> otherwise
315             */
316            public boolean isHidden();
317    
318            /**
319             * Sets whether this document library folder is hidden.
320             *
321             * @param hidden the hidden of this document library folder
322             */
323            public void setHidden(boolean hidden);
324    
325            /**
326             * Returns the override file entry types of this document library folder.
327             *
328             * @return the override file entry types of this document library folder
329             */
330            public boolean getOverrideFileEntryTypes();
331    
332            /**
333             * Returns <code>true</code> if this document library folder is override file entry types.
334             *
335             * @return <code>true</code> if this document library folder is override file entry types; <code>false</code> otherwise
336             */
337            public boolean isOverrideFileEntryTypes();
338    
339            /**
340             * Sets whether this document library folder is override file entry types.
341             *
342             * @param overrideFileEntryTypes the override file entry types of this document library folder
343             */
344            public void setOverrideFileEntryTypes(boolean overrideFileEntryTypes);
345    
346            /**
347             * Returns the status of this document library folder.
348             *
349             * @return the status of this document library folder
350             */
351            public int getStatus();
352    
353            /**
354             * Sets the status of this document library folder.
355             *
356             * @param status the status of this document library folder
357             */
358            public void setStatus(int status);
359    
360            /**
361             * Returns the status by user ID of this document library folder.
362             *
363             * @return the status by user ID of this document library folder
364             */
365            public long getStatusByUserId();
366    
367            /**
368             * Sets the status by user ID of this document library folder.
369             *
370             * @param statusByUserId the status by user ID of this document library folder
371             */
372            public void setStatusByUserId(long statusByUserId);
373    
374            /**
375             * Returns the status by user uuid of this document library folder.
376             *
377             * @return the status by user uuid of this document library folder
378             * @throws SystemException if a system exception occurred
379             */
380            public String getStatusByUserUuid() throws SystemException;
381    
382            /**
383             * Sets the status by user uuid of this document library folder.
384             *
385             * @param statusByUserUuid the status by user uuid of this document library folder
386             */
387            public void setStatusByUserUuid(String statusByUserUuid);
388    
389            /**
390             * Returns the status by user name of this document library folder.
391             *
392             * @return the status by user name of this document library folder
393             */
394            @AutoEscape
395            public String getStatusByUserName();
396    
397            /**
398             * Sets the status by user name of this document library folder.
399             *
400             * @param statusByUserName the status by user name of this document library folder
401             */
402            public void setStatusByUserName(String statusByUserName);
403    
404            /**
405             * Returns the status date of this document library folder.
406             *
407             * @return the status date of this document library folder
408             */
409            public Date getStatusDate();
410    
411            /**
412             * Sets the status date of this document library folder.
413             *
414             * @param statusDate the status date of this document library folder
415             */
416            public void setStatusDate(Date statusDate);
417    
418            /**
419             * @deprecated Renamed to {@link #isApproved()}
420             */
421            public boolean getApproved();
422    
423            /**
424             * Returns <code>true</code> if this document library folder is approved.
425             *
426             * @return <code>true</code> if this document library folder is approved; <code>false</code> otherwise
427             */
428            public boolean isApproved();
429    
430            /**
431             * Returns <code>true</code> if this document library folder is denied.
432             *
433             * @return <code>true</code> if this document library folder is denied; <code>false</code> otherwise
434             */
435            public boolean isDenied();
436    
437            /**
438             * Returns <code>true</code> if this document library folder is a draft.
439             *
440             * @return <code>true</code> if this document library folder is a draft; <code>false</code> otherwise
441             */
442            public boolean isDraft();
443    
444            /**
445             * Returns <code>true</code> if this document library folder is expired.
446             *
447             * @return <code>true</code> if this document library folder is expired; <code>false</code> otherwise
448             */
449            public boolean isExpired();
450    
451            /**
452             * Returns <code>true</code> if this document library folder is inactive.
453             *
454             * @return <code>true</code> if this document library folder is inactive; <code>false</code> otherwise
455             */
456            public boolean isInactive();
457    
458            /**
459             * Returns <code>true</code> if this document library folder is incomplete.
460             *
461             * @return <code>true</code> if this document library folder is incomplete; <code>false</code> otherwise
462             */
463            public boolean isIncomplete();
464    
465            /**
466             * Returns <code>true</code> if this document library folder is in the Recycle Bin.
467             *
468             * @return <code>true</code> if this document library folder is in the Recycle Bin; <code>false</code> otherwise
469             */
470            public boolean isInTrash();
471    
472            /**
473             * Returns <code>true</code> if this document library folder is pending.
474             *
475             * @return <code>true</code> if this document library folder is pending; <code>false</code> otherwise
476             */
477            public boolean isPending();
478    
479            /**
480             * Returns <code>true</code> if this document library folder is scheduled.
481             *
482             * @return <code>true</code> if this document library folder is scheduled; <code>false</code> otherwise
483             */
484            public boolean isScheduled();
485    
486            /**
487             * Returns the container model ID of this document library folder.
488             *
489             * @return the container model ID of this document library folder
490             */
491            public long getContainerModelId();
492    
493            /**
494             * Sets the container model ID of this document library folder.
495             *
496             * @param container model ID of this document library folder
497             */
498            public void setContainerModelId(long containerModelId);
499    
500            /**
501             * Returns the container name of this document library folder.
502             *
503             * @return the container name of this document library folder
504             */
505            public String getContainerModelName();
506    
507            /**
508             * Returns the parent container model ID of this document library folder.
509             *
510             * @return the parent container model ID of this document library folder
511             */
512            public long getParentContainerModelId();
513    
514            /**
515             * Sets the parent container model ID of this document library folder.
516             *
517             * @param parent container model ID of this document library folder
518             */
519            public void setParentContainerModelId(long parentContainerModelId);
520    
521            public boolean isNew();
522    
523            public void setNew(boolean n);
524    
525            public boolean isCachedModel();
526    
527            public void setCachedModel(boolean cachedModel);
528    
529            public boolean isEscapedModel();
530    
531            public Serializable getPrimaryKeyObj();
532    
533            public void setPrimaryKeyObj(Serializable primaryKeyObj);
534    
535            public ExpandoBridge getExpandoBridge();
536    
537            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
538    
539            public Object clone();
540    
541            public int compareTo(DLFolder dlFolder);
542    
543            public int hashCode();
544    
545            public CacheModel<DLFolder> toCacheModel();
546    
547            public DLFolder toEscapedModel();
548    
549            public DLFolder toUnescapedModel();
550    
551            public String toString();
552    
553            public String toXmlString();
554    }