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