001    /**
002     * Copyright (c) 2000-2013 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.GroupedModel;
022    import com.liferay.portal.service.ServiceContext;
023    
024    import com.liferay.portlet.expando.model.ExpandoBridge;
025    
026    import java.io.Serializable;
027    
028    import java.util.Date;
029    
030    /**
031     * 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.
032     *
033     * <p>
034     * 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}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see DLFolder
039     * @see com.liferay.portlet.documentlibrary.model.impl.DLFolderImpl
040     * @see com.liferay.portlet.documentlibrary.model.impl.DLFolderModelImpl
041     * @generated
042     */
043    public interface DLFolderModel extends BaseModel<DLFolder>, GroupedModel {
044            /*
045             * NOTE FOR DEVELOPERS:
046             *
047             * Never modify or reference this interface directly. All methods that expect a document library folder model instance should use the {@link DLFolder} interface instead.
048             */
049    
050            /**
051             * Returns the primary key of this document library folder.
052             *
053             * @return the primary key of this document library folder
054             */
055            public long getPrimaryKey();
056    
057            /**
058             * Sets the primary key of this document library folder.
059             *
060             * @param primaryKey the primary key of this document library folder
061             */
062            public void setPrimaryKey(long primaryKey);
063    
064            /**
065             * Returns the uuid of this document library folder.
066             *
067             * @return the uuid of this document library folder
068             */
069            @AutoEscape
070            public String getUuid();
071    
072            /**
073             * Sets the uuid of this document library folder.
074             *
075             * @param uuid the uuid of this document library folder
076             */
077            public void setUuid(String uuid);
078    
079            /**
080             * Returns the folder ID of this document library folder.
081             *
082             * @return the folder ID of this document library folder
083             */
084            public long getFolderId();
085    
086            /**
087             * Sets the folder ID of this document library folder.
088             *
089             * @param folderId the folder ID of this document library folder
090             */
091            public void setFolderId(long folderId);
092    
093            /**
094             * Returns the group ID of this document library folder.
095             *
096             * @return the group ID of this document library folder
097             */
098            public long getGroupId();
099    
100            /**
101             * Sets the group ID of this document library folder.
102             *
103             * @param groupId the group ID of this document library folder
104             */
105            public void setGroupId(long groupId);
106    
107            /**
108             * Returns the company ID of this document library folder.
109             *
110             * @return the company ID of this document library folder
111             */
112            public long getCompanyId();
113    
114            /**
115             * Sets the company ID of this document library folder.
116             *
117             * @param companyId the company ID of this document library folder
118             */
119            public void setCompanyId(long companyId);
120    
121            /**
122             * Returns the user ID of this document library folder.
123             *
124             * @return the user ID of this document library folder
125             */
126            public long getUserId();
127    
128            /**
129             * Sets the user ID of this document library folder.
130             *
131             * @param userId the user ID of this document library folder
132             */
133            public void setUserId(long userId);
134    
135            /**
136             * Returns the user uuid of this document library folder.
137             *
138             * @return the user uuid of this document library folder
139             * @throws SystemException if a system exception occurred
140             */
141            public String getUserUuid() throws SystemException;
142    
143            /**
144             * Sets the user uuid of this document library folder.
145             *
146             * @param userUuid the user uuid of this document library folder
147             */
148            public void setUserUuid(String userUuid);
149    
150            /**
151             * Returns the user name of this document library folder.
152             *
153             * @return the user name of this document library folder
154             */
155            @AutoEscape
156            public String getUserName();
157    
158            /**
159             * Sets the user name of this document library folder.
160             *
161             * @param userName the user name of this document library folder
162             */
163            public void setUserName(String userName);
164    
165            /**
166             * Returns the create date of this document library folder.
167             *
168             * @return the create date of this document library folder
169             */
170            public Date getCreateDate();
171    
172            /**
173             * Sets the create date of this document library folder.
174             *
175             * @param createDate the create date of this document library folder
176             */
177            public void setCreateDate(Date createDate);
178    
179            /**
180             * Returns the modified date of this document library folder.
181             *
182             * @return the modified date of this document library folder
183             */
184            public Date getModifiedDate();
185    
186            /**
187             * Sets the modified date of this document library folder.
188             *
189             * @param modifiedDate the modified date of this document library folder
190             */
191            public void setModifiedDate(Date modifiedDate);
192    
193            /**
194             * Returns the repository ID of this document library folder.
195             *
196             * @return the repository ID of this document library folder
197             */
198            public long getRepositoryId();
199    
200            /**
201             * Sets the repository ID of this document library folder.
202             *
203             * @param repositoryId the repository ID of this document library folder
204             */
205            public void setRepositoryId(long repositoryId);
206    
207            /**
208             * Returns the mount point of this document library folder.
209             *
210             * @return the mount point of this document library folder
211             */
212            public boolean getMountPoint();
213    
214            /**
215             * Returns <code>true</code> if this document library folder is mount point.
216             *
217             * @return <code>true</code> if this document library folder is mount point; <code>false</code> otherwise
218             */
219            public boolean isMountPoint();
220    
221            /**
222             * Sets whether this document library folder is mount point.
223             *
224             * @param mountPoint the mount point of this document library folder
225             */
226            public void setMountPoint(boolean mountPoint);
227    
228            /**
229             * Returns the parent folder ID of this document library folder.
230             *
231             * @return the parent folder ID of this document library folder
232             */
233            public long getParentFolderId();
234    
235            /**
236             * Sets the parent folder ID of this document library folder.
237             *
238             * @param parentFolderId the parent folder ID of this document library folder
239             */
240            public void setParentFolderId(long parentFolderId);
241    
242            /**
243             * Returns the name of this document library folder.
244             *
245             * @return the name of this document library folder
246             */
247            @AutoEscape
248            public String getName();
249    
250            /**
251             * Sets the name of this document library folder.
252             *
253             * @param name the name of this document library folder
254             */
255            public void setName(String name);
256    
257            /**
258             * Returns the description of this document library folder.
259             *
260             * @return the description of this document library folder
261             */
262            @AutoEscape
263            public String getDescription();
264    
265            /**
266             * Sets the description of this document library folder.
267             *
268             * @param description the description of this document library folder
269             */
270            public void setDescription(String description);
271    
272            /**
273             * Returns the last post date of this document library folder.
274             *
275             * @return the last post date of this document library folder
276             */
277            public Date getLastPostDate();
278    
279            /**
280             * Sets the last post date of this document library folder.
281             *
282             * @param lastPostDate the last post date of this document library folder
283             */
284            public void setLastPostDate(Date lastPostDate);
285    
286            /**
287             * Returns the default file entry type ID of this document library folder.
288             *
289             * @return the default file entry type ID of this document library folder
290             */
291            public long getDefaultFileEntryTypeId();
292    
293            /**
294             * Sets the default file entry type ID of this document library folder.
295             *
296             * @param defaultFileEntryTypeId the default file entry type ID of this document library folder
297             */
298            public void setDefaultFileEntryTypeId(long defaultFileEntryTypeId);
299    
300            /**
301             * Returns the override file entry types of this document library folder.
302             *
303             * @return the override file entry types of this document library folder
304             */
305            public boolean getOverrideFileEntryTypes();
306    
307            /**
308             * Returns <code>true</code> if this document library folder is override file entry types.
309             *
310             * @return <code>true</code> if this document library folder is override file entry types; <code>false</code> otherwise
311             */
312            public boolean isOverrideFileEntryTypes();
313    
314            /**
315             * Sets whether this document library folder is override file entry types.
316             *
317             * @param overrideFileEntryTypes the override file entry types of this document library folder
318             */
319            public void setOverrideFileEntryTypes(boolean overrideFileEntryTypes);
320    
321            public boolean isNew();
322    
323            public void setNew(boolean n);
324    
325            public boolean isCachedModel();
326    
327            public void setCachedModel(boolean cachedModel);
328    
329            public boolean isEscapedModel();
330    
331            public Serializable getPrimaryKeyObj();
332    
333            public void setPrimaryKeyObj(Serializable primaryKeyObj);
334    
335            public ExpandoBridge getExpandoBridge();
336    
337            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
338    
339            public Object clone();
340    
341            public int compareTo(DLFolder dlFolder);
342    
343            public int hashCode();
344    
345            public CacheModel<DLFolder> toCacheModel();
346    
347            public DLFolder toEscapedModel();
348    
349            public DLFolder toUnescapedModel();
350    
351            public String toString();
352    
353            public String toXmlString();
354    }