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