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