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