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