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