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.BaseModel;
020    import com.liferay.portal.model.CacheModel;
021    import com.liferay.portal.model.GroupedModel;
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            GroupedModel, 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            public String getUuid();
073    
074            /**
075             * Sets the uuid of this document library file shortcut.
076             *
077             * @param uuid the uuid of this document library file shortcut
078             */
079            public void setUuid(String uuid);
080    
081            /**
082             * Returns the file shortcut ID of this document library file shortcut.
083             *
084             * @return the file shortcut ID of this document library file shortcut
085             */
086            public long getFileShortcutId();
087    
088            /**
089             * Sets the file shortcut ID of this document library file shortcut.
090             *
091             * @param fileShortcutId the file shortcut ID of this document library file shortcut
092             */
093            public void setFileShortcutId(long fileShortcutId);
094    
095            /**
096             * Returns the group ID of this document library file shortcut.
097             *
098             * @return the group ID of this document library file shortcut
099             */
100            public long getGroupId();
101    
102            /**
103             * Sets the group ID of this document library file shortcut.
104             *
105             * @param groupId the group ID of this document library file shortcut
106             */
107            public void setGroupId(long groupId);
108    
109            /**
110             * Returns the company ID of this document library file shortcut.
111             *
112             * @return the company ID of this document library file shortcut
113             */
114            public long getCompanyId();
115    
116            /**
117             * Sets the company ID of this document library file shortcut.
118             *
119             * @param companyId the company ID of this document library file shortcut
120             */
121            public void setCompanyId(long companyId);
122    
123            /**
124             * Returns the user ID of this document library file shortcut.
125             *
126             * @return the user ID of this document library file shortcut
127             */
128            public long getUserId();
129    
130            /**
131             * Sets the user ID of this document library file shortcut.
132             *
133             * @param userId the user ID of this document library file shortcut
134             */
135            public void setUserId(long userId);
136    
137            /**
138             * Returns the user uuid of this document library file shortcut.
139             *
140             * @return the user uuid of this document library file shortcut
141             * @throws SystemException if a system exception occurred
142             */
143            public String getUserUuid() throws SystemException;
144    
145            /**
146             * Sets the user uuid of this document library file shortcut.
147             *
148             * @param userUuid the user uuid of this document library file shortcut
149             */
150            public void setUserUuid(String userUuid);
151    
152            /**
153             * Returns the user name of this document library file shortcut.
154             *
155             * @return the user name of this document library file shortcut
156             */
157            @AutoEscape
158            public String getUserName();
159    
160            /**
161             * Sets the user name of this document library file shortcut.
162             *
163             * @param userName the user name of this document library file shortcut
164             */
165            public void setUserName(String userName);
166    
167            /**
168             * Returns the create date of this document library file shortcut.
169             *
170             * @return the create date of this document library file shortcut
171             */
172            public Date getCreateDate();
173    
174            /**
175             * Sets the create date of this document library file shortcut.
176             *
177             * @param createDate the create date of this document library file shortcut
178             */
179            public void setCreateDate(Date createDate);
180    
181            /**
182             * Returns the modified date of this document library file shortcut.
183             *
184             * @return the modified date of this document library file shortcut
185             */
186            public Date getModifiedDate();
187    
188            /**
189             * Sets the modified date of this document library file shortcut.
190             *
191             * @param modifiedDate the modified date of this document library file shortcut
192             */
193            public void setModifiedDate(Date modifiedDate);
194    
195            /**
196             * Returns the repository ID of this document library file shortcut.
197             *
198             * @return the repository ID of this document library file shortcut
199             */
200            public long getRepositoryId();
201    
202            /**
203             * Sets the repository ID of this document library file shortcut.
204             *
205             * @param repositoryId the repository ID of this document library file shortcut
206             */
207            public void setRepositoryId(long repositoryId);
208    
209            /**
210             * Returns the folder ID of this document library file shortcut.
211             *
212             * @return the folder ID of this document library file shortcut
213             */
214            public long getFolderId();
215    
216            /**
217             * Sets the folder ID of this document library file shortcut.
218             *
219             * @param folderId the folder ID of this document library file shortcut
220             */
221            public void setFolderId(long folderId);
222    
223            /**
224             * Returns the to file entry ID of this document library file shortcut.
225             *
226             * @return the to file entry ID of this document library file shortcut
227             */
228            public long getToFileEntryId();
229    
230            /**
231             * Sets the to file entry ID of this document library file shortcut.
232             *
233             * @param toFileEntryId the to file entry ID of this document library file shortcut
234             */
235            public void setToFileEntryId(long toFileEntryId);
236    
237            /**
238             * Returns the active of this document library file shortcut.
239             *
240             * @return the active of this document library file shortcut
241             */
242            public boolean getActive();
243    
244            /**
245             * Returns <code>true</code> if this document library file shortcut is active.
246             *
247             * @return <code>true</code> if this document library file shortcut is active; <code>false</code> otherwise
248             */
249            public boolean isActive();
250    
251            /**
252             * Sets whether this document library file shortcut is active.
253             *
254             * @param active the active of this document library file shortcut
255             */
256            public void setActive(boolean active);
257    
258            /**
259             * Returns the status of this document library file shortcut.
260             *
261             * @return the status of this document library file shortcut
262             */
263            public int getStatus();
264    
265            /**
266             * Sets the status of this document library file shortcut.
267             *
268             * @param status the status of this document library file shortcut
269             */
270            public void setStatus(int status);
271    
272            /**
273             * Returns the status by user ID of this document library file shortcut.
274             *
275             * @return the status by user ID of this document library file shortcut
276             */
277            public long getStatusByUserId();
278    
279            /**
280             * Sets the status by user ID of this document library file shortcut.
281             *
282             * @param statusByUserId the status by user ID of this document library file shortcut
283             */
284            public void setStatusByUserId(long statusByUserId);
285    
286            /**
287             * Returns the status by user uuid of this document library file shortcut.
288             *
289             * @return the status by user uuid of this document library file shortcut
290             * @throws SystemException if a system exception occurred
291             */
292            public String getStatusByUserUuid() throws SystemException;
293    
294            /**
295             * Sets the status by user uuid of this document library file shortcut.
296             *
297             * @param statusByUserUuid the status by user uuid of this document library file shortcut
298             */
299            public void setStatusByUserUuid(String statusByUserUuid);
300    
301            /**
302             * Returns the status by user name of this document library file shortcut.
303             *
304             * @return the status by user name of this document library file shortcut
305             */
306            @AutoEscape
307            public String getStatusByUserName();
308    
309            /**
310             * Sets the status by user name of this document library file shortcut.
311             *
312             * @param statusByUserName the status by user name of this document library file shortcut
313             */
314            public void setStatusByUserName(String statusByUserName);
315    
316            /**
317             * Returns the status date of this document library file shortcut.
318             *
319             * @return the status date of this document library file shortcut
320             */
321            public Date getStatusDate();
322    
323            /**
324             * Sets the status date of this document library file shortcut.
325             *
326             * @param statusDate the status date of this document library file shortcut
327             */
328            public void setStatusDate(Date statusDate);
329    
330            /**
331             * @deprecated Renamed to {@link #isApproved()}
332             */
333            public boolean getApproved();
334    
335            /**
336             * Returns <code>true</code> if this document library file shortcut is approved.
337             *
338             * @return <code>true</code> if this document library file shortcut is approved; <code>false</code> otherwise
339             */
340            public boolean isApproved();
341    
342            /**
343             * Returns <code>true</code> if this document library file shortcut is denied.
344             *
345             * @return <code>true</code> if this document library file shortcut is denied; <code>false</code> otherwise
346             */
347            public boolean isDenied();
348    
349            /**
350             * Returns <code>true</code> if this document library file shortcut is a draft.
351             *
352             * @return <code>true</code> if this document library file shortcut is a draft; <code>false</code> otherwise
353             */
354            public boolean isDraft();
355    
356            /**
357             * Returns <code>true</code> if this document library file shortcut is expired.
358             *
359             * @return <code>true</code> if this document library file shortcut is expired; <code>false</code> otherwise
360             */
361            public boolean isExpired();
362    
363            /**
364             * Returns <code>true</code> if this document library file shortcut is inactive.
365             *
366             * @return <code>true</code> if this document library file shortcut is inactive; <code>false</code> otherwise
367             */
368            public boolean isInactive();
369    
370            /**
371             * Returns <code>true</code> if this document library file shortcut is incomplete.
372             *
373             * @return <code>true</code> if this document library file shortcut is incomplete; <code>false</code> otherwise
374             */
375            public boolean isIncomplete();
376    
377            /**
378             * Returns <code>true</code> if this document library file shortcut is in the Recycle Bin.
379             *
380             * @return <code>true</code> if this document library file shortcut is in the Recycle Bin; <code>false</code> otherwise
381             */
382            public boolean isInTrash();
383    
384            /**
385             * Returns <code>true</code> if this document library file shortcut is pending.
386             *
387             * @return <code>true</code> if this document library file shortcut is pending; <code>false</code> otherwise
388             */
389            public boolean isPending();
390    
391            /**
392             * Returns <code>true</code> if this document library file shortcut is scheduled.
393             *
394             * @return <code>true</code> if this document library file shortcut is scheduled; <code>false</code> otherwise
395             */
396            public boolean isScheduled();
397    
398            public boolean isNew();
399    
400            public void setNew(boolean n);
401    
402            public boolean isCachedModel();
403    
404            public void setCachedModel(boolean cachedModel);
405    
406            public boolean isEscapedModel();
407    
408            public Serializable getPrimaryKeyObj();
409    
410            public void setPrimaryKeyObj(Serializable primaryKeyObj);
411    
412            public ExpandoBridge getExpandoBridge();
413    
414            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
415    
416            public Object clone();
417    
418            public int compareTo(DLFileShortcut dlFileShortcut);
419    
420            public int hashCode();
421    
422            public CacheModel<DLFileShortcut> toCacheModel();
423    
424            public DLFileShortcut toEscapedModel();
425    
426            public String toString();
427    
428            public String toXmlString();
429    }