001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 d l file shortcut model instance should use the {@link DLFileShortcut} interface instead.
050             */
051    
052            /**
053             * Gets the primary key of this d l file shortcut.
054             *
055             * @return the primary key of this d l file shortcut
056             */
057            public long getPrimaryKey();
058    
059            /**
060             * Sets the primary key of this d l file shortcut
061             *
062             * @param primaryKey the primary key of this d l file shortcut
063             */
064            public void setPrimaryKey(long primaryKey);
065    
066            /**
067             * Gets the uuid of this d l file shortcut.
068             *
069             * @return the uuid of this d l file shortcut
070             */
071            @AutoEscape
072            public String getUuid();
073    
074            /**
075             * Sets the uuid of this d l file shortcut.
076             *
077             * @param uuid the uuid of this d l file shortcut
078             */
079            public void setUuid(String uuid);
080    
081            /**
082             * Gets the file shortcut ID of this d l file shortcut.
083             *
084             * @return the file shortcut ID of this d l file shortcut
085             */
086            public long getFileShortcutId();
087    
088            /**
089             * Sets the file shortcut ID of this d l file shortcut.
090             *
091             * @param fileShortcutId the file shortcut ID of this d l file shortcut
092             */
093            public void setFileShortcutId(long fileShortcutId);
094    
095            /**
096             * Gets the group ID of this d l file shortcut.
097             *
098             * @return the group ID of this d l file shortcut
099             */
100            public long getGroupId();
101    
102            /**
103             * Sets the group ID of this d l file shortcut.
104             *
105             * @param groupId the group ID of this d l file shortcut
106             */
107            public void setGroupId(long groupId);
108    
109            /**
110             * Gets the company ID of this d l file shortcut.
111             *
112             * @return the company ID of this d l file shortcut
113             */
114            public long getCompanyId();
115    
116            /**
117             * Sets the company ID of this d l file shortcut.
118             *
119             * @param companyId the company ID of this d l file shortcut
120             */
121            public void setCompanyId(long companyId);
122    
123            /**
124             * Gets the user ID of this d l file shortcut.
125             *
126             * @return the user ID of this d l file shortcut
127             */
128            public long getUserId();
129    
130            /**
131             * Sets the user ID of this d l file shortcut.
132             *
133             * @param userId the user ID of this d l file shortcut
134             */
135            public void setUserId(long userId);
136    
137            /**
138             * Gets the user uuid of this d l file shortcut.
139             *
140             * @return the user uuid of this d l 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 d l file shortcut.
147             *
148             * @param userUuid the user uuid of this d l file shortcut
149             */
150            public void setUserUuid(String userUuid);
151    
152            /**
153             * Gets the user name of this d l file shortcut.
154             *
155             * @return the user name of this d l file shortcut
156             */
157            @AutoEscape
158            public String getUserName();
159    
160            /**
161             * Sets the user name of this d l file shortcut.
162             *
163             * @param userName the user name of this d l file shortcut
164             */
165            public void setUserName(String userName);
166    
167            /**
168             * Gets the create date of this d l file shortcut.
169             *
170             * @return the create date of this d l file shortcut
171             */
172            public Date getCreateDate();
173    
174            /**
175             * Sets the create date of this d l file shortcut.
176             *
177             * @param createDate the create date of this d l file shortcut
178             */
179            public void setCreateDate(Date createDate);
180    
181            /**
182             * Gets the modified date of this d l file shortcut.
183             *
184             * @return the modified date of this d l file shortcut
185             */
186            public Date getModifiedDate();
187    
188            /**
189             * Sets the modified date of this d l file shortcut.
190             *
191             * @param modifiedDate the modified date of this d l file shortcut
192             */
193            public void setModifiedDate(Date modifiedDate);
194    
195            /**
196             * Gets the folder ID of this d l file shortcut.
197             *
198             * @return the folder ID of this d l file shortcut
199             */
200            public long getFolderId();
201    
202            /**
203             * Sets the folder ID of this d l file shortcut.
204             *
205             * @param folderId the folder ID of this d l file shortcut
206             */
207            public void setFolderId(long folderId);
208    
209            /**
210             * Gets the to file entry ID of this d l file shortcut.
211             *
212             * @return the to file entry ID of this d l file shortcut
213             */
214            public long getToFileEntryId();
215    
216            /**
217             * Sets the to file entry ID of this d l file shortcut.
218             *
219             * @param toFileEntryId the to file entry ID of this d l file shortcut
220             */
221            public void setToFileEntryId(long toFileEntryId);
222    
223            /**
224             * Gets the status of this d l file shortcut.
225             *
226             * @return the status of this d l file shortcut
227             */
228            public int getStatus();
229    
230            /**
231             * Sets the status of this d l file shortcut.
232             *
233             * @param status the status of this d l file shortcut
234             */
235            public void setStatus(int status);
236    
237            /**
238             * Gets the status by user ID of this d l file shortcut.
239             *
240             * @return the status by user ID of this d l file shortcut
241             */
242            public long getStatusByUserId();
243    
244            /**
245             * Sets the status by user ID of this d l file shortcut.
246             *
247             * @param statusByUserId the status by user ID of this d l file shortcut
248             */
249            public void setStatusByUserId(long statusByUserId);
250    
251            /**
252             * Gets the status by user uuid of this d l file shortcut.
253             *
254             * @return the status by user uuid of this d l file shortcut
255             * @throws SystemException if a system exception occurred
256             */
257            public String getStatusByUserUuid() throws SystemException;
258    
259            /**
260             * Sets the status by user uuid of this d l file shortcut.
261             *
262             * @param statusByUserUuid the status by user uuid of this d l file shortcut
263             */
264            public void setStatusByUserUuid(String statusByUserUuid);
265    
266            /**
267             * Gets the status by user name of this d l file shortcut.
268             *
269             * @return the status by user name of this d l file shortcut
270             */
271            @AutoEscape
272            public String getStatusByUserName();
273    
274            /**
275             * Sets the status by user name of this d l file shortcut.
276             *
277             * @param statusByUserName the status by user name of this d l file shortcut
278             */
279            public void setStatusByUserName(String statusByUserName);
280    
281            /**
282             * Gets the status date of this d l file shortcut.
283             *
284             * @return the status date of this d l file shortcut
285             */
286            public Date getStatusDate();
287    
288            /**
289             * Sets the status date of this d l file shortcut.
290             *
291             * @param statusDate the status date of this d l file shortcut
292             */
293            public void setStatusDate(Date statusDate);
294    
295            /**
296             * @deprecated {@link #isApproved}
297             */
298            public boolean getApproved();
299    
300            /**
301             * Determines if this d l file shortcut is approved.
302             *
303             * @return <code>true</code> if this d l file shortcut is approved; <code>false</code> otherwise
304             */
305            public boolean isApproved();
306    
307            /**
308             * Determines if this d l file shortcut is a draft.
309             *
310             * @return <code>true</code> if this d l file shortcut is a draft; <code>false</code> otherwise
311             */
312            public boolean isDraft();
313    
314            /**
315             * Determines if this d l file shortcut is expired.
316             *
317             * @return <code>true</code> if this d l file shortcut is expired; <code>false</code> otherwise
318             */
319            public boolean isExpired();
320    
321            /**
322             * Determines if this d l file shortcut is pending.
323             *
324             * @return <code>true</code> if this d l file shortcut is pending; <code>false</code> otherwise
325             */
326            public boolean isPending();
327    
328            public boolean isNew();
329    
330            public void setNew(boolean n);
331    
332            public boolean isCachedModel();
333    
334            public void setCachedModel(boolean cachedModel);
335    
336            public boolean isEscapedModel();
337    
338            public void setEscapedModel(boolean escapedModel);
339    
340            public Serializable getPrimaryKeyObj();
341    
342            public void setPrimaryKeyObj(Serializable primaryKeyObj);
343    
344            public ExpandoBridge getExpandoBridge();
345    
346            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
347    
348            public Object clone();
349    
350            public int compareTo(DLFileShortcut dlFileShortcut);
351    
352            public int hashCode();
353    
354            public CacheModel<DLFileShortcut> toCacheModel();
355    
356            public DLFileShortcut toEscapedModel();
357    
358            public String toString();
359    
360            public String toXmlString();
361    }