001    /**
002     * Copyright (c) 2000-2011 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.social.model;
016    
017    import com.liferay.portal.kernel.exception.SystemException;
018    import com.liferay.portal.model.BaseModel;
019    import com.liferay.portal.model.CacheModel;
020    import com.liferay.portal.service.ServiceContext;
021    
022    import com.liferay.portlet.expando.model.ExpandoBridge;
023    
024    import java.io.Serializable;
025    
026    /**
027     * The base model interface for the SocialEquityUser service. Represents a row in the "SocialEquityUser" database table, with each column mapped to a property of this class.
028     *
029     * <p>
030     * This interface and its corresponding implementation {@link com.liferay.portlet.social.model.impl.SocialEquityUserModelImpl} 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.social.model.impl.SocialEquityUserImpl}.
031     * </p>
032     *
033     * @author Brian Wing Shun Chan
034     * @see SocialEquityUser
035     * @see com.liferay.portlet.social.model.impl.SocialEquityUserImpl
036     * @see com.liferay.portlet.social.model.impl.SocialEquityUserModelImpl
037     * @generated
038     */
039    public interface SocialEquityUserModel extends BaseModel<SocialEquityUser> {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. All methods that expect a social equity user model instance should use the {@link SocialEquityUser} interface instead.
044             */
045    
046            /**
047             * Returns the primary key of this social equity user.
048             *
049             * @return the primary key of this social equity user
050             */
051            public long getPrimaryKey();
052    
053            /**
054             * Sets the primary key of this social equity user.
055             *
056             * @param primaryKey the primary key of this social equity user
057             */
058            public void setPrimaryKey(long primaryKey);
059    
060            /**
061             * Returns the equity user ID of this social equity user.
062             *
063             * @return the equity user ID of this social equity user
064             */
065            public long getEquityUserId();
066    
067            /**
068             * Sets the equity user ID of this social equity user.
069             *
070             * @param equityUserId the equity user ID of this social equity user
071             */
072            public void setEquityUserId(long equityUserId);
073    
074            /**
075             * Returns the equity user uuid of this social equity user.
076             *
077             * @return the equity user uuid of this social equity user
078             * @throws SystemException if a system exception occurred
079             */
080            public String getEquityUserUuid() throws SystemException;
081    
082            /**
083             * Sets the equity user uuid of this social equity user.
084             *
085             * @param equityUserUuid the equity user uuid of this social equity user
086             */
087            public void setEquityUserUuid(String equityUserUuid);
088    
089            /**
090             * Returns the group ID of this social equity user.
091             *
092             * @return the group ID of this social equity user
093             */
094            public long getGroupId();
095    
096            /**
097             * Sets the group ID of this social equity user.
098             *
099             * @param groupId the group ID of this social equity user
100             */
101            public void setGroupId(long groupId);
102    
103            /**
104             * Returns the company ID of this social equity user.
105             *
106             * @return the company ID of this social equity user
107             */
108            public long getCompanyId();
109    
110            /**
111             * Sets the company ID of this social equity user.
112             *
113             * @param companyId the company ID of this social equity user
114             */
115            public void setCompanyId(long companyId);
116    
117            /**
118             * Returns the user ID of this social equity user.
119             *
120             * @return the user ID of this social equity user
121             */
122            public long getUserId();
123    
124            /**
125             * Sets the user ID of this social equity user.
126             *
127             * @param userId the user ID of this social equity user
128             */
129            public void setUserId(long userId);
130    
131            /**
132             * Returns the user uuid of this social equity user.
133             *
134             * @return the user uuid of this social equity user
135             * @throws SystemException if a system exception occurred
136             */
137            public String getUserUuid() throws SystemException;
138    
139            /**
140             * Sets the user uuid of this social equity user.
141             *
142             * @param userUuid the user uuid of this social equity user
143             */
144            public void setUserUuid(String userUuid);
145    
146            /**
147             * Returns the contribution k of this social equity user.
148             *
149             * @return the contribution k of this social equity user
150             */
151            public double getContributionK();
152    
153            /**
154             * Sets the contribution k of this social equity user.
155             *
156             * @param contributionK the contribution k of this social equity user
157             */
158            public void setContributionK(double contributionK);
159    
160            /**
161             * Returns the contribution b of this social equity user.
162             *
163             * @return the contribution b of this social equity user
164             */
165            public double getContributionB();
166    
167            /**
168             * Sets the contribution b of this social equity user.
169             *
170             * @param contributionB the contribution b of this social equity user
171             */
172            public void setContributionB(double contributionB);
173    
174            /**
175             * Returns the participation k of this social equity user.
176             *
177             * @return the participation k of this social equity user
178             */
179            public double getParticipationK();
180    
181            /**
182             * Sets the participation k of this social equity user.
183             *
184             * @param participationK the participation k of this social equity user
185             */
186            public void setParticipationK(double participationK);
187    
188            /**
189             * Returns the participation b of this social equity user.
190             *
191             * @return the participation b of this social equity user
192             */
193            public double getParticipationB();
194    
195            /**
196             * Sets the participation b of this social equity user.
197             *
198             * @param participationB the participation b of this social equity user
199             */
200            public void setParticipationB(double participationB);
201    
202            /**
203             * Returns the rank of this social equity user.
204             *
205             * @return the rank of this social equity user
206             */
207            public int getRank();
208    
209            /**
210             * Sets the rank of this social equity user.
211             *
212             * @param rank the rank of this social equity user
213             */
214            public void setRank(int rank);
215    
216            public boolean isNew();
217    
218            public void setNew(boolean n);
219    
220            public boolean isCachedModel();
221    
222            public void setCachedModel(boolean cachedModel);
223    
224            public boolean isEscapedModel();
225    
226            public Serializable getPrimaryKeyObj();
227    
228            public void setPrimaryKeyObj(Serializable primaryKeyObj);
229    
230            public ExpandoBridge getExpandoBridge();
231    
232            public void setExpandoBridgeAttributes(ServiceContext serviceContext);
233    
234            public Object clone();
235    
236            public int compareTo(SocialEquityUser socialEquityUser);
237    
238            public int hashCode();
239    
240            public CacheModel<SocialEquityUser> toCacheModel();
241    
242            public SocialEquityUser toEscapedModel();
243    
244            public String toString();
245    
246            public String toXmlString();
247    }