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