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