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.BaseModel;
023    import com.liferay.portal.model.CacheModel;
024    import com.liferay.portal.model.ShardedModel;
025    import com.liferay.portal.model.StagedGroupedModel;
026    import com.liferay.portal.model.TrashedModel;
027    import com.liferay.portal.model.WorkflowedModel;
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 DLFileShortcut service. Represents a row in the "DLFileShortcut" 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.DLFileShortcutModelImpl} 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.DLFileShortcutImpl}.
042     * </p>
043     *
044     * @author Brian Wing Shun Chan
045     * @see DLFileShortcut
046     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutImpl
047     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl
048     * @generated
049     */
050    @ProviderType
051    public interface DLFileShortcutModel extends BaseModel<DLFileShortcut>,
052            ShardedModel, StagedGroupedModel, TrashedModel, WorkflowedModel {
053            /*
054             * NOTE FOR DEVELOPERS:
055             *
056             * Never modify or reference this interface directly. All methods that expect a document library file shortcut model instance should use the {@link DLFileShortcut} interface instead.
057             */
058    
059            /**
060             * Returns the primary key of this document library file shortcut.
061             *
062             * @return the primary key of this document library file shortcut
063             */
064            public long getPrimaryKey();
065    
066            /**
067             * Sets the primary key of this document library file shortcut.
068             *
069             * @param primaryKey the primary key of this document library file shortcut
070             */
071            public void setPrimaryKey(long primaryKey);
072    
073            /**
074             * Returns the uuid of this document library file shortcut.
075             *
076             * @return the uuid of this document library file shortcut
077             */
078            @AutoEscape
079            @Override
080            public String getUuid();
081    
082            /**
083             * Sets the uuid of this document library file shortcut.
084             *
085             * @param uuid the uuid of this document library file shortcut
086             */
087            @Override
088            public void setUuid(String uuid);
089    
090            /**
091             * Returns the file shortcut ID of this document library file shortcut.
092             *
093             * @return the file shortcut ID of this document library file shortcut
094             */
095            public long getFileShortcutId();
096    
097            /**
098             * Sets the file shortcut ID of this document library file shortcut.
099             *
100             * @param fileShortcutId the file shortcut ID of this document library file shortcut
101             */
102            public void setFileShortcutId(long fileShortcutId);
103    
104            /**
105             * Returns the group ID of this document library file shortcut.
106             *
107             * @return the group ID of this document library file shortcut
108             */
109            @Override
110            public long getGroupId();
111    
112            /**
113             * Sets the group ID of this document library file shortcut.
114             *
115             * @param groupId the group ID of this document library file shortcut
116             */
117            @Override
118            public void setGroupId(long groupId);
119    
120            /**
121             * Returns the company ID of this document library file shortcut.
122             *
123             * @return the company ID of this document library file shortcut
124             */
125            @Override
126            public long getCompanyId();
127    
128            /**
129             * Sets the company ID of this document library file shortcut.
130             *
131             * @param companyId the company ID of this document library file shortcut
132             */
133            @Override
134            public void setCompanyId(long companyId);
135    
136            /**
137             * Returns the user ID of this document library file shortcut.
138             *
139             * @return the user ID of this document library file shortcut
140             */
141            @Override
142            public long getUserId();
143    
144            /**
145             * Sets the user ID of this document library file shortcut.
146             *
147             * @param userId the user ID of this document library file shortcut
148             */
149            @Override
150            public void setUserId(long userId);
151    
152            /**
153             * Returns the user uuid of this document library file shortcut.
154             *
155             * @return the user uuid of this document library file shortcut
156             */
157            @Override
158            public String getUserUuid();
159    
160            /**
161             * Sets the user uuid of this document library file shortcut.
162             *
163             * @param userUuid the user uuid of this document library file shortcut
164             */
165            @Override
166            public void setUserUuid(String userUuid);
167    
168            /**
169             * Returns the user name of this document library file shortcut.
170             *
171             * @return the user name of this document library file shortcut
172             */
173            @AutoEscape
174            @Override
175            public String getUserName();
176    
177            /**
178             * Sets the user name of this document library file shortcut.
179             *
180             * @param userName the user name of this document library file shortcut
181             */
182            @Override
183            public void setUserName(String userName);
184    
185            /**
186             * Returns the create date of this document library file shortcut.
187             *
188             * @return the create date of this document library file shortcut
189             */
190            @Override
191            public Date getCreateDate();
192    
193            /**
194             * Sets the create date of this document library file shortcut.
195             *
196             * @param createDate the create date of this document library file shortcut
197             */
198            @Override
199            public void setCreateDate(Date createDate);
200    
201            /**
202             * Returns the modified date of this document library file shortcut.
203             *
204             * @return the modified date of this document library file shortcut
205             */
206            @Override
207            public Date getModifiedDate();
208    
209            /**
210             * Sets the modified date of this document library file shortcut.
211             *
212             * @param modifiedDate the modified date of this document library file shortcut
213             */
214            @Override
215            public void setModifiedDate(Date modifiedDate);
216    
217            /**
218             * Returns the repository ID of this document library file shortcut.
219             *
220             * @return the repository ID of this document library file shortcut
221             */
222            public long getRepositoryId();
223    
224            /**
225             * Sets the repository ID of this document library file shortcut.
226             *
227             * @param repositoryId the repository ID of this document library file shortcut
228             */
229            public void setRepositoryId(long repositoryId);
230    
231            /**
232             * Returns the folder ID of this document library file shortcut.
233             *
234             * @return the folder ID of this document library file shortcut
235             */
236            public long getFolderId();
237    
238            /**
239             * Sets the folder ID of this document library file shortcut.
240             *
241             * @param folderId the folder ID of this document library file shortcut
242             */
243            public void setFolderId(long folderId);
244    
245            /**
246             * Returns the to file entry ID of this document library file shortcut.
247             *
248             * @return the to file entry ID of this document library file shortcut
249             */
250            public long getToFileEntryId();
251    
252            /**
253             * Sets the to file entry ID of this document library file shortcut.
254             *
255             * @param toFileEntryId the to file entry ID of this document library file shortcut
256             */
257            public void setToFileEntryId(long toFileEntryId);
258    
259            /**
260             * Returns the tree path of this document library file shortcut.
261             *
262             * @return the tree path of this document library file shortcut
263             */
264            @AutoEscape
265            public String getTreePath();
266    
267            /**
268             * Sets the tree path of this document library file shortcut.
269             *
270             * @param treePath the tree path of this document library file shortcut
271             */
272            public void setTreePath(String treePath);
273    
274            /**
275             * Returns the active of this document library file shortcut.
276             *
277             * @return the active of this document library file shortcut
278             */
279            public boolean getActive();
280    
281            /**
282             * Returns <code>true</code> if this document library file shortcut is active.
283             *
284             * @return <code>true</code> if this document library file shortcut is active; <code>false</code> otherwise
285             */
286            public boolean isActive();
287    
288            /**
289             * Sets whether this document library file shortcut is active.
290             *
291             * @param active the active of this document library file shortcut
292             */
293            public void setActive(boolean active);
294    
295            /**
296             * Returns the last publish date of this document library file shortcut.
297             *
298             * @return the last publish date of this document library file shortcut
299             */
300            @Override
301            public Date getLastPublishDate();
302    
303            /**
304             * Sets the last publish date of this document library file shortcut.
305             *
306             * @param lastPublishDate the last publish date of this document library file shortcut
307             */
308            @Override
309            public void setLastPublishDate(Date lastPublishDate);
310    
311            /**
312             * Returns the status of this document library file shortcut.
313             *
314             * @return the status of this document library file shortcut
315             */
316            @Override
317            public int getStatus();
318    
319            /**
320             * Sets the status of this document library file shortcut.
321             *
322             * @param status the status of this document library file shortcut
323             */
324            @Override
325            public void setStatus(int status);
326    
327            /**
328             * Returns the status by user ID of this document library file shortcut.
329             *
330             * @return the status by user ID of this document library file shortcut
331             */
332            @Override
333            public long getStatusByUserId();
334    
335            /**
336             * Sets the status by user ID of this document library file shortcut.
337             *
338             * @param statusByUserId the status by user ID of this document library file shortcut
339             */
340            @Override
341            public void setStatusByUserId(long statusByUserId);
342    
343            /**
344             * Returns the status by user uuid of this document library file shortcut.
345             *
346             * @return the status by user uuid of this document library file shortcut
347             */
348            @Override
349            public String getStatusByUserUuid();
350    
351            /**
352             * Sets the status by user uuid of this document library file shortcut.
353             *
354             * @param statusByUserUuid the status by user uuid of this document library file shortcut
355             */
356            @Override
357            public void setStatusByUserUuid(String statusByUserUuid);
358    
359            /**
360             * Returns the status by user name of this document library file shortcut.
361             *
362             * @return the status by user name of this document library file shortcut
363             */
364            @AutoEscape
365            @Override
366            public String getStatusByUserName();
367    
368            /**
369             * Sets the status by user name of this document library file shortcut.
370             *
371             * @param statusByUserName the status by user name of this document library file shortcut
372             */
373            @Override
374            public void setStatusByUserName(String statusByUserName);
375    
376            /**
377             * Returns the status date of this document library file shortcut.
378             *
379             * @return the status date of this document library file shortcut
380             */
381            @Override
382            public Date getStatusDate();
383    
384            /**
385             * Sets the status date of this document library file shortcut.
386             *
387             * @param statusDate the status date of this document library file shortcut
388             */
389            @Override
390            public void setStatusDate(Date statusDate);
391    
392            /**
393             * Returns the trash entry created when this document library file shortcut was moved to the Recycle Bin. The trash entry may belong to one of the ancestors of this document library file shortcut.
394             *
395             * @return the trash entry created when this document library file shortcut was moved to the Recycle Bin
396             */
397            @Override
398            public TrashEntry getTrashEntry() throws PortalException;
399    
400            /**
401             * Returns the class primary key of the trash entry for this document library file shortcut.
402             *
403             * @return the class primary key of the trash entry for this document library file shortcut
404             */
405            @Override
406            public long getTrashEntryClassPK();
407    
408            /**
409             * Returns the trash handler for this document library file shortcut.
410             *
411             * @return the trash handler for this document library file shortcut
412             */
413            @Override
414            public TrashHandler getTrashHandler();
415    
416            /**
417             * Returns <code>true</code> if this document library file shortcut is in the Recycle Bin.
418             *
419             * @return <code>true</code> if this document library file shortcut is in the Recycle Bin; <code>false</code> otherwise
420             */
421            @Override
422            public boolean isInTrash();
423    
424            /**
425             * Returns <code>true</code> if the parent of this document library file shortcut is in the Recycle Bin.
426             *
427             * @return <code>true</code> if the parent of this document library file shortcut is in the Recycle Bin; <code>false</code> otherwise
428             */
429            @Override
430            public boolean isInTrashContainer();
431    
432            @Override
433            public boolean isInTrashExplicitly();
434    
435            @Override
436            public boolean isInTrashImplicitly();
437    
438            /**
439             * Returns <code>true</code> if this document library file shortcut is approved.
440             *
441             * @return <code>true</code> if this document library file shortcut is approved; <code>false</code> otherwise
442             */
443            @Override
444            public boolean isApproved();
445    
446            /**
447             * Returns <code>true</code> if this document library file shortcut is denied.
448             *
449             * @return <code>true</code> if this document library file shortcut is denied; <code>false</code> otherwise
450             */
451            @Override
452            public boolean isDenied();
453    
454            /**
455             * Returns <code>true</code> if this document library file shortcut is a draft.
456             *
457             * @return <code>true</code> if this document library file shortcut is a draft; <code>false</code> otherwise
458             */
459            @Override
460            public boolean isDraft();
461    
462            /**
463             * Returns <code>true</code> if this document library file shortcut is expired.
464             *
465             * @return <code>true</code> if this document library file shortcut is expired; <code>false</code> otherwise
466             */
467            @Override
468            public boolean isExpired();
469    
470            /**
471             * Returns <code>true</code> if this document library file shortcut is inactive.
472             *
473             * @return <code>true</code> if this document library file shortcut is inactive; <code>false</code> otherwise
474             */
475            @Override
476            public boolean isInactive();
477    
478            /**
479             * Returns <code>true</code> if this document library file shortcut is incomplete.
480             *
481             * @return <code>true</code> if this document library file shortcut is incomplete; <code>false</code> otherwise
482             */
483            @Override
484            public boolean isIncomplete();
485    
486            /**
487             * Returns <code>true</code> if this document library file shortcut is pending.
488             *
489             * @return <code>true</code> if this document library file shortcut is pending; <code>false</code> otherwise
490             */
491            @Override
492            public boolean isPending();
493    
494            /**
495             * Returns <code>true</code> if this document library file shortcut is scheduled.
496             *
497             * @return <code>true</code> if this document library file shortcut is scheduled; <code>false</code> otherwise
498             */
499            @Override
500            public boolean isScheduled();
501    
502            @Override
503            public boolean isNew();
504    
505            @Override
506            public void setNew(boolean n);
507    
508            @Override
509            public boolean isCachedModel();
510    
511            @Override
512            public void setCachedModel(boolean cachedModel);
513    
514            @Override
515            public boolean isEscapedModel();
516    
517            @Override
518            public Serializable getPrimaryKeyObj();
519    
520            @Override
521            public void setPrimaryKeyObj(Serializable primaryKeyObj);
522    
523            @Override
524            public ExpandoBridge getExpandoBridge();
525    
526            @Override
527            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
528    
529            @Override
530            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
531    
532            @Override
533            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
534    
535            @Override
536            public Object clone();
537    
538            @Override
539            public int compareTo(
540                    com.liferay.portlet.documentlibrary.model.DLFileShortcut dlFileShortcut);
541    
542            @Override
543            public int hashCode();
544    
545            @Override
546            public CacheModel<com.liferay.portlet.documentlibrary.model.DLFileShortcut> toCacheModel();
547    
548            @Override
549            public com.liferay.portlet.documentlibrary.model.DLFileShortcut toEscapedModel();
550    
551            @Override
552            public com.liferay.portlet.documentlibrary.model.DLFileShortcut toUnescapedModel();
553    
554            @Override
555            public String toString();
556    
557            @Override
558            public String toXmlString();
559    }