001    /**
002     * Copyright (c) 2000-2010 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.annotation.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.BaseModel;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    import java.util.Date;
027    
028    /**
029     * 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.
030     *
031     * <p>
032     * 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}.
033     * </p>
034     *
035     * <p>
036     * 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.
037     * </p>
038     *
039     * @author Brian Wing Shun Chan
040     * @see DLFileShortcut
041     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutImpl
042     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl
043     * @generated
044     */
045    public interface DLFileShortcutModel extends BaseModel<DLFileShortcut> {
046            /**
047             * Gets the primary key of this d l file shortcut.
048             *
049             * @return the primary key of this d l file shortcut
050             */
051            public long getPrimaryKey();
052    
053            /**
054             * Sets the primary key of this d l file shortcut
055             *
056             * @param pk the primary key of this d l file shortcut
057             */
058            public void setPrimaryKey(long pk);
059    
060            /**
061             * Gets the uuid of this d l file shortcut.
062             *
063             * @return the uuid of this d l file shortcut
064             */
065            @AutoEscape
066            public String getUuid();
067    
068            /**
069             * Sets the uuid of this d l file shortcut.
070             *
071             * @param uuid the uuid of this d l file shortcut
072             */
073            public void setUuid(String uuid);
074    
075            /**
076             * Gets the file shortcut id of this d l file shortcut.
077             *
078             * @return the file shortcut id of this d l file shortcut
079             */
080            public long getFileShortcutId();
081    
082            /**
083             * Sets the file shortcut id of this d l file shortcut.
084             *
085             * @param fileShortcutId the file shortcut id of this d l file shortcut
086             */
087            public void setFileShortcutId(long fileShortcutId);
088    
089            /**
090             * Gets the group id of this d l file shortcut.
091             *
092             * @return the group id of this d l file shortcut
093             */
094            public long getGroupId();
095    
096            /**
097             * Sets the group id of this d l file shortcut.
098             *
099             * @param groupId the group id of this d l file shortcut
100             */
101            public void setGroupId(long groupId);
102    
103            /**
104             * Gets the company id of this d l file shortcut.
105             *
106             * @return the company id of this d l file shortcut
107             */
108            public long getCompanyId();
109    
110            /**
111             * Sets the company id of this d l file shortcut.
112             *
113             * @param companyId the company id of this d l file shortcut
114             */
115            public void setCompanyId(long companyId);
116    
117            /**
118             * Gets the user id of this d l file shortcut.
119             *
120             * @return the user id of this d l file shortcut
121             */
122            public long getUserId();
123    
124            /**
125             * Sets the user id of this d l file shortcut.
126             *
127             * @param userId the user id of this d l file shortcut
128             */
129            public void setUserId(long userId);
130    
131            /**
132             * Gets the user uuid of this d l file shortcut.
133             *
134             * @return the user uuid of this d l file shortcut
135             * @throws SystemException if a system exception occurred
136             */
137            public String getUserUuid() throws SystemException;
138    
139            /**
140             * Sets the user uuid of this d l file shortcut.
141             *
142             * @param userUuid the user uuid of this d l file shortcut
143             */
144            public void setUserUuid(String userUuid);
145    
146            /**
147             * Gets the user name of this d l file shortcut.
148             *
149             * @return the user name of this d l file shortcut
150             */
151            @AutoEscape
152            public String getUserName();
153    
154            /**
155             * Sets the user name of this d l file shortcut.
156             *
157             * @param userName the user name of this d l file shortcut
158             */
159            public void setUserName(String userName);
160    
161            /**
162             * Gets the create date of this d l file shortcut.
163             *
164             * @return the create date of this d l file shortcut
165             */
166            public Date getCreateDate();
167    
168            /**
169             * Sets the create date of this d l file shortcut.
170             *
171             * @param createDate the create date of this d l file shortcut
172             */
173            public void setCreateDate(Date createDate);
174    
175            /**
176             * Gets the modified date of this d l file shortcut.
177             *
178             * @return the modified date of this d l file shortcut
179             */
180            public Date getModifiedDate();
181    
182            /**
183             * Sets the modified date of this d l file shortcut.
184             *
185             * @param modifiedDate the modified date of this d l file shortcut
186             */
187            public void setModifiedDate(Date modifiedDate);
188    
189            /**
190             * Gets the folder id of this d l file shortcut.
191             *
192             * @return the folder id of this d l file shortcut
193             */
194            public long getFolderId();
195    
196            /**
197             * Sets the folder id of this d l file shortcut.
198             *
199             * @param folderId the folder id of this d l file shortcut
200             */
201            public void setFolderId(long folderId);
202    
203            /**
204             * Gets the to folder id of this d l file shortcut.
205             *
206             * @return the to folder id of this d l file shortcut
207             */
208            public long getToFolderId();
209    
210            /**
211             * Sets the to folder id of this d l file shortcut.
212             *
213             * @param toFolderId the to folder id of this d l file shortcut
214             */
215            public void setToFolderId(long toFolderId);
216    
217            /**
218             * Gets the to name of this d l file shortcut.
219             *
220             * @return the to name of this d l file shortcut
221             */
222            @AutoEscape
223            public String getToName();
224    
225            /**
226             * Sets the to name of this d l file shortcut.
227             *
228             * @param toName the to name of this d l file shortcut
229             */
230            public void setToName(String toName);
231    
232            /**
233             * Gets the status of this d l file shortcut.
234             *
235             * @return the status of this d l file shortcut
236             */
237            public int getStatus();
238    
239            /**
240             * Sets the status of this d l file shortcut.
241             *
242             * @param status the status of this d l file shortcut
243             */
244            public void setStatus(int status);
245    
246            /**
247             * Gets the status by user id of this d l file shortcut.
248             *
249             * @return the status by user id of this d l file shortcut
250             */
251            public long getStatusByUserId();
252    
253            /**
254             * Sets the status by user id of this d l file shortcut.
255             *
256             * @param statusByUserId the status by user id of this d l file shortcut
257             */
258            public void setStatusByUserId(long statusByUserId);
259    
260            /**
261             * Gets the status by user uuid of this d l file shortcut.
262             *
263             * @return the status by user uuid of this d l file shortcut
264             * @throws SystemException if a system exception occurred
265             */
266            public String getStatusByUserUuid() throws SystemException;
267    
268            /**
269             * Sets the status by user uuid of this d l file shortcut.
270             *
271             * @param statusByUserUuid the status by user uuid of this d l file shortcut
272             */
273            public void setStatusByUserUuid(String statusByUserUuid);
274    
275            /**
276             * Gets the status by user name of this d l file shortcut.
277             *
278             * @return the status by user name of this d l file shortcut
279             */
280            @AutoEscape
281            public String getStatusByUserName();
282    
283            /**
284             * Sets the status by user name of this d l file shortcut.
285             *
286             * @param statusByUserName the status by user name of this d l file shortcut
287             */
288            public void setStatusByUserName(String statusByUserName);
289    
290            /**
291             * Gets the status date of this d l file shortcut.
292             *
293             * @return the status date of this d l file shortcut
294             */
295            public Date getStatusDate();
296    
297            /**
298             * Sets the status date of this d l file shortcut.
299             *
300             * @param statusDate the status date of this d l file shortcut
301             */
302            public void setStatusDate(Date statusDate);
303    
304            /**
305             * Determines whether this d l file shortcut is approved.
306             *
307             * @return true if this d l file shortcut is approved; false otherwise
308             */
309            public boolean isApproved();
310    
311            /**
312             * Determines whether this d l file shortcut is a draft.
313             *
314             * @return true if this d l file shortcut is a draft; false otherwise
315             */
316            public boolean isDraft();
317    
318            /**
319             * Determines whether this d l file shortcut is expired.
320             *
321             * @return true if this d l file shortcut is expired; false otherwise
322             */
323            public boolean isExpired();
324    
325            /**
326             * Determines whether this d l file shortcut is pending.
327             *
328             * @return true if this d l file shortcut is pending; false otherwise
329             */
330            public boolean isPending();
331    
332            /**
333             * Gets a copy of this d l file shortcut as an escaped model instance by wrapping it with an {@link com.liferay.portal.kernel.bean.AutoEscapeBeanHandler}.
334             *
335             * @return the escaped model instance
336             * @see com.liferay.portal.kernel.bean.AutoEscapeBeanHandler
337             */
338            public DLFileShortcut toEscapedModel();
339    
340            public boolean isNew();
341    
342            public void setNew(boolean n);
343    
344            public boolean isCachedModel();
345    
346            public void setCachedModel(boolean cachedModel);
347    
348            public boolean isEscapedModel();
349    
350            public void setEscapedModel(boolean escapedModel);
351    
352            public Serializable getPrimaryKeyObj();
353    
354            public ExpandoBridge getExpandoBridge();
355    
356            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
357    
358            public Object clone();
359    
360            public int compareTo(DLFileShortcut dlFileShortcut);
361    
362            public int hashCode();
363    
364            public String toString();
365    
366            public String toXmlString();
367    }