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