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