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.ratings.model;
016    
017    import com.liferay.portal.kernel.bean.AutoEscape;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.model.AttachedModel;
020    import com.liferay.portal.model.AuditedModel;
021    import com.liferay.portal.model.BaseModel;
022    import com.liferay.portal.model.CacheModel;
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 RatingsEntry service. Represents a row in the "RatingsEntry" 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.ratings.model.impl.RatingsEntryModelImpl} 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.ratings.model.impl.RatingsEntryImpl}.
036     * </p>
037     *
038     * @author Brian Wing Shun Chan
039     * @see RatingsEntry
040     * @see com.liferay.portlet.ratings.model.impl.RatingsEntryImpl
041     * @see com.liferay.portlet.ratings.model.impl.RatingsEntryModelImpl
042     * @generated
043     */
044    public interface RatingsEntryModel extends AttachedModel, AuditedModel,
045            BaseModel<RatingsEntry> {
046            /*
047             * NOTE FOR DEVELOPERS:
048             *
049             * Never modify or reference this interface directly. All methods that expect a ratings entry model instance should use the {@link RatingsEntry} interface instead.
050             */
051    
052            /**
053             * Returns the primary key of this ratings entry.
054             *
055             * @return the primary key of this ratings entry
056             */
057            public long getPrimaryKey();
058    
059            /**
060             * Sets the primary key of this ratings entry.
061             *
062             * @param primaryKey the primary key of this ratings entry
063             */
064            public void setPrimaryKey(long primaryKey);
065    
066            /**
067             * Returns the entry ID of this ratings entry.
068             *
069             * @return the entry ID of this ratings entry
070             */
071            public long getEntryId();
072    
073            /**
074             * Sets the entry ID of this ratings entry.
075             *
076             * @param entryId the entry ID of this ratings entry
077             */
078            public void setEntryId(long entryId);
079    
080            /**
081             * Returns the company ID of this ratings entry.
082             *
083             * @return the company ID of this ratings entry
084             */
085            public long getCompanyId();
086    
087            /**
088             * Sets the company ID of this ratings entry.
089             *
090             * @param companyId the company ID of this ratings entry
091             */
092            public void setCompanyId(long companyId);
093    
094            /**
095             * Returns the user ID of this ratings entry.
096             *
097             * @return the user ID of this ratings entry
098             */
099            public long getUserId();
100    
101            /**
102             * Sets the user ID of this ratings entry.
103             *
104             * @param userId the user ID of this ratings entry
105             */
106            public void setUserId(long userId);
107    
108            /**
109             * Returns the user uuid of this ratings entry.
110             *
111             * @return the user uuid of this ratings entry
112             * @throws SystemException if a system exception occurred
113             */
114            public String getUserUuid() throws SystemException;
115    
116            /**
117             * Sets the user uuid of this ratings entry.
118             *
119             * @param userUuid the user uuid of this ratings entry
120             */
121            public void setUserUuid(String userUuid);
122    
123            /**
124             * Returns the user name of this ratings entry.
125             *
126             * @return the user name of this ratings entry
127             */
128            @AutoEscape
129            public String getUserName();
130    
131            /**
132             * Sets the user name of this ratings entry.
133             *
134             * @param userName the user name of this ratings entry
135             */
136            public void setUserName(String userName);
137    
138            /**
139             * Returns the create date of this ratings entry.
140             *
141             * @return the create date of this ratings entry
142             */
143            public Date getCreateDate();
144    
145            /**
146             * Sets the create date of this ratings entry.
147             *
148             * @param createDate the create date of this ratings entry
149             */
150            public void setCreateDate(Date createDate);
151    
152            /**
153             * Returns the modified date of this ratings entry.
154             *
155             * @return the modified date of this ratings entry
156             */
157            public Date getModifiedDate();
158    
159            /**
160             * Sets the modified date of this ratings entry.
161             *
162             * @param modifiedDate the modified date of this ratings entry
163             */
164            public void setModifiedDate(Date modifiedDate);
165    
166            /**
167             * Returns the fully qualified class name of this ratings entry.
168             *
169             * @return the fully qualified class name of this ratings entry
170             */
171            public String getClassName();
172    
173            /**
174             * Returns the class name ID of this ratings entry.
175             *
176             * @return the class name ID of this ratings entry
177             */
178            public long getClassNameId();
179    
180            /**
181             * Sets the class name ID of this ratings entry.
182             *
183             * @param classNameId the class name ID of this ratings entry
184             */
185            public void setClassNameId(long classNameId);
186    
187            /**
188             * Returns the class p k of this ratings entry.
189             *
190             * @return the class p k of this ratings entry
191             */
192            public long getClassPK();
193    
194            /**
195             * Sets the class p k of this ratings entry.
196             *
197             * @param classPK the class p k of this ratings entry
198             */
199            public void setClassPK(long classPK);
200    
201            /**
202             * Returns the score of this ratings entry.
203             *
204             * @return the score of this ratings entry
205             */
206            public double getScore();
207    
208            /**
209             * Sets the score of this ratings entry.
210             *
211             * @param score the score of this ratings entry
212             */
213            public void setScore(double score);
214    
215            public boolean isNew();
216    
217            public void setNew(boolean n);
218    
219            public boolean isCachedModel();
220    
221            public void setCachedModel(boolean cachedModel);
222    
223            public boolean isEscapedModel();
224    
225            public Serializable getPrimaryKeyObj();
226    
227            public void setPrimaryKeyObj(Serializable primaryKeyObj);
228    
229            public ExpandoBridge getExpandoBridge();
230    
231            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
232    
233            public Object clone();
234    
235            public int compareTo(RatingsEntry ratingsEntry);
236    
237            public int hashCode();
238    
239            public CacheModel<RatingsEntry> toCacheModel();
240    
241            public RatingsEntry toEscapedModel();
242    
243            public String toString();
244    
245            public String toXmlString();
246    }