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.GroupedModel;
022    import com.liferay.portal.model.WorkflowedModel;
023    import com.liferay.portal.service.ServiceContext;
024    
025    import com.liferay.portlet.expando.model.ExpandoBridge;
026    
027    import java.io.Serializable;
028    
029    import java.util.Date;
030    
031    /**
032     * The base model interface for the DLFileVersion service. Represents a row in the "DLFileVersion" database table, with each column mapped to a property of this class.
033     *
034     * <p>
035     * This interface and its corresponding implementation {@link com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl} 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.DLFileVersionImpl}.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see DLFileVersion
040     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileVersionImpl
041     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileVersionModelImpl
042     * @generated
043     */
044    public interface DLFileVersionModel extends BaseModel<DLFileVersion>,
045            GroupedModel, WorkflowedModel {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. All methods that expect a document library file version model instance should use the {@link DLFileVersion} interface instead.
050             */
051    
052            /**
053             * Returns the primary key of this document library file version.
054             *
055             * @return the primary key of this document library file version
056             */
057            public long getPrimaryKey();
058    
059            /**
060             * Sets the primary key of this document library file version.
061             *
062             * @param primaryKey the primary key of this document library file version
063             */
064            public void setPrimaryKey(long primaryKey);
065    
066            /**
067             * Returns the file version ID of this document library file version.
068             *
069             * @return the file version ID of this document library file version
070             */
071            public long getFileVersionId();
072    
073            /**
074             * Sets the file version ID of this document library file version.
075             *
076             * @param fileVersionId the file version ID of this document library file version
077             */
078            public void setFileVersionId(long fileVersionId);
079    
080            /**
081             * Returns the group ID of this document library file version.
082             *
083             * @return the group ID of this document library file version
084             */
085            public long getGroupId();
086    
087            /**
088             * Sets the group ID of this document library file version.
089             *
090             * @param groupId the group ID of this document library file version
091             */
092            public void setGroupId(long groupId);
093    
094            /**
095             * Returns the company ID of this document library file version.
096             *
097             * @return the company ID of this document library file version
098             */
099            public long getCompanyId();
100    
101            /**
102             * Sets the company ID of this document library file version.
103             *
104             * @param companyId the company ID of this document library file version
105             */
106            public void setCompanyId(long companyId);
107    
108            /**
109             * Returns the user ID of this document library file version.
110             *
111             * @return the user ID of this document library file version
112             */
113            public long getUserId();
114    
115            /**
116             * Sets the user ID of this document library file version.
117             *
118             * @param userId the user ID of this document library file version
119             */
120            public void setUserId(long userId);
121    
122            /**
123             * Returns the user uuid of this document library file version.
124             *
125             * @return the user uuid of this document library file version
126             * @throws SystemException if a system exception occurred
127             */
128            public String getUserUuid() throws SystemException;
129    
130            /**
131             * Sets the user uuid of this document library file version.
132             *
133             * @param userUuid the user uuid of this document library file version
134             */
135            public void setUserUuid(String userUuid);
136    
137            /**
138             * Returns the user name of this document library file version.
139             *
140             * @return the user name of this document library file version
141             */
142            @AutoEscape
143            public String getUserName();
144    
145            /**
146             * Sets the user name of this document library file version.
147             *
148             * @param userName the user name of this document library file version
149             */
150            public void setUserName(String userName);
151    
152            /**
153             * Returns the create date of this document library file version.
154             *
155             * @return the create date of this document library file version
156             */
157            public Date getCreateDate();
158    
159            /**
160             * Sets the create date of this document library file version.
161             *
162             * @param createDate the create date of this document library file version
163             */
164            public void setCreateDate(Date createDate);
165    
166            /**
167             * Returns the modified date of this document library file version.
168             *
169             * @return the modified date of this document library file version
170             */
171            public Date getModifiedDate();
172    
173            /**
174             * Sets the modified date of this document library file version.
175             *
176             * @param modifiedDate the modified date of this document library file version
177             */
178            public void setModifiedDate(Date modifiedDate);
179    
180            /**
181             * Returns the repository ID of this document library file version.
182             *
183             * @return the repository ID of this document library file version
184             */
185            public long getRepositoryId();
186    
187            /**
188             * Sets the repository ID of this document library file version.
189             *
190             * @param repositoryId the repository ID of this document library file version
191             */
192            public void setRepositoryId(long repositoryId);
193    
194            /**
195             * Returns the folder ID of this document library file version.
196             *
197             * @return the folder ID of this document library file version
198             */
199            public long getFolderId();
200    
201            /**
202             * Sets the folder ID of this document library file version.
203             *
204             * @param folderId the folder ID of this document library file version
205             */
206            public void setFolderId(long folderId);
207    
208            /**
209             * Returns the file entry ID of this document library file version.
210             *
211             * @return the file entry ID of this document library file version
212             */
213            public long getFileEntryId();
214    
215            /**
216             * Sets the file entry ID of this document library file version.
217             *
218             * @param fileEntryId the file entry ID of this document library file version
219             */
220            public void setFileEntryId(long fileEntryId);
221    
222            /**
223             * Returns the extension of this document library file version.
224             *
225             * @return the extension of this document library file version
226             */
227            @AutoEscape
228            public String getExtension();
229    
230            /**
231             * Sets the extension of this document library file version.
232             *
233             * @param extension the extension of this document library file version
234             */
235            public void setExtension(String extension);
236    
237            /**
238             * Returns the mime type of this document library file version.
239             *
240             * @return the mime type of this document library file version
241             */
242            @AutoEscape
243            public String getMimeType();
244    
245            /**
246             * Sets the mime type of this document library file version.
247             *
248             * @param mimeType the mime type of this document library file version
249             */
250            public void setMimeType(String mimeType);
251    
252            /**
253             * Returns the title of this document library file version.
254             *
255             * @return the title of this document library file version
256             */
257            @AutoEscape
258            public String getTitle();
259    
260            /**
261             * Sets the title of this document library file version.
262             *
263             * @param title the title of this document library file version
264             */
265            public void setTitle(String title);
266    
267            /**
268             * Returns the description of this document library file version.
269             *
270             * @return the description of this document library file version
271             */
272            @AutoEscape
273            public String getDescription();
274    
275            /**
276             * Sets the description of this document library file version.
277             *
278             * @param description the description of this document library file version
279             */
280            public void setDescription(String description);
281    
282            /**
283             * Returns the change log of this document library file version.
284             *
285             * @return the change log of this document library file version
286             */
287            @AutoEscape
288            public String getChangeLog();
289    
290            /**
291             * Sets the change log of this document library file version.
292             *
293             * @param changeLog the change log of this document library file version
294             */
295            public void setChangeLog(String changeLog);
296    
297            /**
298             * Returns the extra settings of this document library file version.
299             *
300             * @return the extra settings of this document library file version
301             */
302            @AutoEscape
303            public String getExtraSettings();
304    
305            /**
306             * Sets the extra settings of this document library file version.
307             *
308             * @param extraSettings the extra settings of this document library file version
309             */
310            public void setExtraSettings(String extraSettings);
311    
312            /**
313             * Returns the file entry type ID of this document library file version.
314             *
315             * @return the file entry type ID of this document library file version
316             */
317            public long getFileEntryTypeId();
318    
319            /**
320             * Sets the file entry type ID of this document library file version.
321             *
322             * @param fileEntryTypeId the file entry type ID of this document library file version
323             */
324            public void setFileEntryTypeId(long fileEntryTypeId);
325    
326            /**
327             * Returns the version of this document library file version.
328             *
329             * @return the version of this document library file version
330             */
331            @AutoEscape
332            public String getVersion();
333    
334            /**
335             * Sets the version of this document library file version.
336             *
337             * @param version the version of this document library file version
338             */
339            public void setVersion(String version);
340    
341            /**
342             * Returns the size of this document library file version.
343             *
344             * @return the size of this document library file version
345             */
346            public long getSize();
347    
348            /**
349             * Sets the size of this document library file version.
350             *
351             * @param size the size of this document library file version
352             */
353            public void setSize(long size);
354    
355            /**
356             * Returns the status of this document library file version.
357             *
358             * @return the status of this document library file version
359             */
360            public int getStatus();
361    
362            /**
363             * Sets the status of this document library file version.
364             *
365             * @param status the status of this document library file version
366             */
367            public void setStatus(int status);
368    
369            /**
370             * Returns the status by user ID of this document library file version.
371             *
372             * @return the status by user ID of this document library file version
373             */
374            public long getStatusByUserId();
375    
376            /**
377             * Sets the status by user ID of this document library file version.
378             *
379             * @param statusByUserId the status by user ID of this document library file version
380             */
381            public void setStatusByUserId(long statusByUserId);
382    
383            /**
384             * Returns the status by user uuid of this document library file version.
385             *
386             * @return the status by user uuid of this document library file version
387             * @throws SystemException if a system exception occurred
388             */
389            public String getStatusByUserUuid() throws SystemException;
390    
391            /**
392             * Sets the status by user uuid of this document library file version.
393             *
394             * @param statusByUserUuid the status by user uuid of this document library file version
395             */
396            public void setStatusByUserUuid(String statusByUserUuid);
397    
398            /**
399             * Returns the status by user name of this document library file version.
400             *
401             * @return the status by user name of this document library file version
402             */
403            @AutoEscape
404            public String getStatusByUserName();
405    
406            /**
407             * Sets the status by user name of this document library file version.
408             *
409             * @param statusByUserName the status by user name of this document library file version
410             */
411            public void setStatusByUserName(String statusByUserName);
412    
413            /**
414             * Returns the status date of this document library file version.
415             *
416             * @return the status date of this document library file version
417             */
418            public Date getStatusDate();
419    
420            /**
421             * Sets the status date of this document library file version.
422             *
423             * @param statusDate the status date of this document library file version
424             */
425            public void setStatusDate(Date statusDate);
426    
427            /**
428             * @deprecated Renamed to {@link #isApproved()}
429             */
430            public boolean getApproved();
431    
432            /**
433             * Returns <code>true</code> if this document library file version is approved.
434             *
435             * @return <code>true</code> if this document library file version is approved; <code>false</code> otherwise
436             */
437            public boolean isApproved();
438    
439            /**
440             * Returns <code>true</code> if this document library file version is a draft.
441             *
442             * @return <code>true</code> if this document library file version is a draft; <code>false</code> otherwise
443             */
444            public boolean isDraft();
445    
446            /**
447             * Returns <code>true</code> if this document library file version is expired.
448             *
449             * @return <code>true</code> if this document library file version is expired; <code>false</code> otherwise
450             */
451            public boolean isExpired();
452    
453            /**
454             * Returns <code>true</code> if this document library file version is pending.
455             *
456             * @return <code>true</code> if this document library file version is pending; <code>false</code> otherwise
457             */
458            public boolean isPending();
459    
460            public boolean isNew();
461    
462            public void setNew(boolean n);
463    
464            public boolean isCachedModel();
465    
466            public void setCachedModel(boolean cachedModel);
467    
468            public boolean isEscapedModel();
469    
470            public Serializable getPrimaryKeyObj();
471    
472            public void setPrimaryKeyObj(Serializable primaryKeyObj);
473    
474            public ExpandoBridge getExpandoBridge();
475    
476            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
477    
478            public Object clone();
479    
480            public int compareTo(DLFileVersion dlFileVersion);
481    
482            public int hashCode();
483    
484            public CacheModel<DLFileVersion> toCacheModel();
485    
486            public DLFileVersion toEscapedModel();
487    
488            public String toString();
489    
490            public String toXmlString();
491    }