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