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