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.service.ServiceContext;
023    
024    import com.liferay.portlet.expando.model.ExpandoBridge;
025    
026    import java.io.Serializable;
027    
028    import java.util.Date;
029    
030    /**
031     * The base model interface for the DLFileRank service. Represents a row in the "DLFileRank" database table, with each column mapped to a property of this class.
032     *
033     * <p>
034     * This interface and its corresponding implementation {@link com.liferay.portlet.documentlibrary.model.impl.DLFileRankModelImpl} 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.DLFileRankImpl}.
035     * </p>
036     *
037     * @author Brian Wing Shun Chan
038     * @see DLFileRank
039     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileRankImpl
040     * @see com.liferay.portlet.documentlibrary.model.impl.DLFileRankModelImpl
041     * @generated
042     */
043    public interface DLFileRankModel extends BaseModel<DLFileRank>,
044            StagedGroupedModel {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. All methods that expect a document library file rank model instance should use the {@link DLFileRank} interface instead.
049             */
050    
051            /**
052             * Returns the primary key of this document library file rank.
053             *
054             * @return the primary key of this document library file rank
055             */
056            public long getPrimaryKey();
057    
058            /**
059             * Sets the primary key of this document library file rank.
060             *
061             * @param primaryKey the primary key of this document library file rank
062             */
063            public void setPrimaryKey(long primaryKey);
064    
065            /**
066             * Returns the uuid of this document library file rank.
067             *
068             * @return the uuid of this document library file rank
069             */
070            @AutoEscape
071            public String getUuid();
072    
073            /**
074             * Sets the uuid of this document library file rank.
075             *
076             * @param uuid the uuid of this document library file rank
077             */
078            public void setUuid(String uuid);
079    
080            /**
081             * Returns the file rank ID of this document library file rank.
082             *
083             * @return the file rank ID of this document library file rank
084             */
085            public long getFileRankId();
086    
087            /**
088             * Sets the file rank ID of this document library file rank.
089             *
090             * @param fileRankId the file rank ID of this document library file rank
091             */
092            public void setFileRankId(long fileRankId);
093    
094            /**
095             * Returns the group ID of this document library file rank.
096             *
097             * @return the group ID of this document library file rank
098             */
099            public long getGroupId();
100    
101            /**
102             * Sets the group ID of this document library file rank.
103             *
104             * @param groupId the group ID of this document library file rank
105             */
106            public void setGroupId(long groupId);
107    
108            /**
109             * Returns the company ID of this document library file rank.
110             *
111             * @return the company ID of this document library file rank
112             */
113            public long getCompanyId();
114    
115            /**
116             * Sets the company ID of this document library file rank.
117             *
118             * @param companyId the company ID of this document library file rank
119             */
120            public void setCompanyId(long companyId);
121    
122            /**
123             * Returns the user ID of this document library file rank.
124             *
125             * @return the user ID of this document library file rank
126             */
127            public long getUserId();
128    
129            /**
130             * Sets the user ID of this document library file rank.
131             *
132             * @param userId the user ID of this document library file rank
133             */
134            public void setUserId(long userId);
135    
136            /**
137             * Returns the user uuid of this document library file rank.
138             *
139             * @return the user uuid of this document library file rank
140             * @throws SystemException if a system exception occurred
141             */
142            public String getUserUuid() throws SystemException;
143    
144            /**
145             * Sets the user uuid of this document library file rank.
146             *
147             * @param userUuid the user uuid of this document library file rank
148             */
149            public void setUserUuid(String userUuid);
150    
151            /**
152             * Returns the user name of this document library file rank.
153             *
154             * @return the user name of this document library file rank
155             */
156            @AutoEscape
157            public String getUserName();
158    
159            /**
160             * Sets the user name of this document library file rank.
161             *
162             * @param userName the user name of this document library file rank
163             */
164            public void setUserName(String userName);
165    
166            /**
167             * Returns the create date of this document library file rank.
168             *
169             * @return the create date of this document library file rank
170             */
171            public Date getCreateDate();
172    
173            /**
174             * Sets the create date of this document library file rank.
175             *
176             * @param createDate the create date of this document library file rank
177             */
178            public void setCreateDate(Date createDate);
179    
180            /**
181             * Returns the modified date of this document library file rank.
182             *
183             * @return the modified date of this document library file rank
184             */
185            public Date getModifiedDate();
186    
187            /**
188             * Sets the modified date of this document library file rank.
189             *
190             * @param modifiedDate the modified date of this document library file rank
191             */
192            public void setModifiedDate(Date modifiedDate);
193    
194            /**
195             * Returns the file entry ID of this document library file rank.
196             *
197             * @return the file entry ID of this document library file rank
198             */
199            public long getFileEntryId();
200    
201            /**
202             * Sets the file entry ID of this document library file rank.
203             *
204             * @param fileEntryId the file entry ID of this document library file rank
205             */
206            public void setFileEntryId(long fileEntryId);
207    
208            /**
209             * Returns the active of this document library file rank.
210             *
211             * @return the active of this document library file rank
212             */
213            public boolean getActive();
214    
215            /**
216             * Returns <code>true</code> if this document library file rank is active.
217             *
218             * @return <code>true</code> if this document library file rank is active; <code>false</code> otherwise
219             */
220            public boolean isActive();
221    
222            /**
223             * Sets whether this document library file rank is active.
224             *
225             * @param active the active of this document library file rank
226             */
227            public void setActive(boolean active);
228    
229            public boolean isNew();
230    
231            public void setNew(boolean n);
232    
233            public boolean isCachedModel();
234    
235            public void setCachedModel(boolean cachedModel);
236    
237            public boolean isEscapedModel();
238    
239            public Serializable getPrimaryKeyObj();
240    
241            public void setPrimaryKeyObj(Serializable primaryKeyObj);
242    
243            public ExpandoBridge getExpandoBridge();
244    
245            public void setExpandoBridgeAttributes(BaseModel<?> baseModel);
246    
247            public void setExpandoBridgeAttributes(ExpandoBridge expandoBridge);
248    
249            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
250    
251            public Object clone();
252    
253            public int compareTo(DLFileRank dlFileRank);
254    
255            public int hashCode();
256    
257            public CacheModel<DLFileRank> toCacheModel();
258    
259            public DLFileRank toEscapedModel();
260    
261            public DLFileRank toUnescapedModel();
262    
263            public String toString();
264    
265            public String toXmlString();
266    }