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