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.service.persistence;
016    
017    import com.liferay.portal.kernel.exception.SystemException;
018    import com.liferay.portal.service.persistence.BasePersistence;
019    
020    import com.liferay.portlet.social.model.SocialEquityUser;
021    
022    /**
023     * The persistence interface for the social equity user service.
024     *
025     * <p>
026     * Caching information and settings can be found in <code>portal.properties</code>
027     * </p>
028     *
029     * @author Brian Wing Shun Chan
030     * @see SocialEquityUserPersistenceImpl
031     * @see SocialEquityUserUtil
032     * @generated
033     */
034    public interface SocialEquityUserPersistence extends BasePersistence<SocialEquityUser> {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify or reference this interface directly. Always use {@link SocialEquityUserUtil} to access the social equity user persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
039             */
040    
041            /**
042            * Caches the social equity user in the entity cache if it is enabled.
043            *
044            * @param socialEquityUser the social equity user
045            */
046            public void cacheResult(
047                    com.liferay.portlet.social.model.SocialEquityUser socialEquityUser);
048    
049            /**
050            * Caches the social equity users in the entity cache if it is enabled.
051            *
052            * @param socialEquityUsers the social equity users
053            */
054            public void cacheResult(
055                    java.util.List<com.liferay.portlet.social.model.SocialEquityUser> socialEquityUsers);
056    
057            /**
058            * Creates a new social equity user with the primary key. Does not add the social equity user to the database.
059            *
060            * @param equityUserId the primary key for the new social equity user
061            * @return the new social equity user
062            */
063            public com.liferay.portlet.social.model.SocialEquityUser create(
064                    long equityUserId);
065    
066            /**
067            * Removes the social equity user with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param equityUserId the primary key of the social equity user
070            * @return the social equity user that was removed
071            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a social equity user with the primary key could not be found
072            * @throws SystemException if a system exception occurred
073            */
074            public com.liferay.portlet.social.model.SocialEquityUser remove(
075                    long equityUserId)
076                    throws com.liferay.portal.kernel.exception.SystemException,
077                            com.liferay.portlet.social.NoSuchEquityUserException;
078    
079            public com.liferay.portlet.social.model.SocialEquityUser updateImpl(
080                    com.liferay.portlet.social.model.SocialEquityUser socialEquityUser,
081                    boolean merge)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Returns the social equity user with the primary key or throws a {@link com.liferay.portlet.social.NoSuchEquityUserException} if it could not be found.
086            *
087            * @param equityUserId the primary key of the social equity user
088            * @return the social equity user
089            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a social equity user with the primary key could not be found
090            * @throws SystemException if a system exception occurred
091            */
092            public com.liferay.portlet.social.model.SocialEquityUser findByPrimaryKey(
093                    long equityUserId)
094                    throws com.liferay.portal.kernel.exception.SystemException,
095                            com.liferay.portlet.social.NoSuchEquityUserException;
096    
097            /**
098            * Returns the social equity user with the primary key or returns <code>null</code> if it could not be found.
099            *
100            * @param equityUserId the primary key of the social equity user
101            * @return the social equity user, or <code>null</code> if a social equity user with the primary key could not be found
102            * @throws SystemException if a system exception occurred
103            */
104            public com.liferay.portlet.social.model.SocialEquityUser fetchByPrimaryKey(
105                    long equityUserId)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Returns all the social equity users where groupId = &#63;.
110            *
111            * @param groupId the group ID
112            * @return the matching social equity users
113            * @throws SystemException if a system exception occurred
114            */
115            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByGroupId(
116                    long groupId)
117                    throws com.liferay.portal.kernel.exception.SystemException;
118    
119            /**
120            * Returns a range of all the social equity users where groupId = &#63;.
121            *
122            * <p>
123            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
124            * </p>
125            *
126            * @param groupId the group ID
127            * @param start the lower bound of the range of social equity users
128            * @param end the upper bound of the range of social equity users (not inclusive)
129            * @return the range of matching social equity users
130            * @throws SystemException if a system exception occurred
131            */
132            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByGroupId(
133                    long groupId, int start, int end)
134                    throws com.liferay.portal.kernel.exception.SystemException;
135    
136            /**
137            * Returns an ordered range of all the social equity users where groupId = &#63;.
138            *
139            * <p>
140            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
141            * </p>
142            *
143            * @param groupId the group ID
144            * @param start the lower bound of the range of social equity users
145            * @param end the upper bound of the range of social equity users (not inclusive)
146            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
147            * @return the ordered range of matching social equity users
148            * @throws SystemException if a system exception occurred
149            */
150            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByGroupId(
151                    long groupId, int start, int end,
152                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
153                    throws com.liferay.portal.kernel.exception.SystemException;
154    
155            /**
156            * Returns the first social equity user in the ordered set where groupId = &#63;.
157            *
158            * <p>
159            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
160            * </p>
161            *
162            * @param groupId the group ID
163            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
164            * @return the first matching social equity user
165            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
166            * @throws SystemException if a system exception occurred
167            */
168            public com.liferay.portlet.social.model.SocialEquityUser findByGroupId_First(
169                    long groupId,
170                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
171                    throws com.liferay.portal.kernel.exception.SystemException,
172                            com.liferay.portlet.social.NoSuchEquityUserException;
173    
174            /**
175            * Returns the last social equity user in the ordered set where groupId = &#63;.
176            *
177            * <p>
178            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
179            * </p>
180            *
181            * @param groupId the group ID
182            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
183            * @return the last matching social equity user
184            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
185            * @throws SystemException if a system exception occurred
186            */
187            public com.liferay.portlet.social.model.SocialEquityUser findByGroupId_Last(
188                    long groupId,
189                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
190                    throws com.liferay.portal.kernel.exception.SystemException,
191                            com.liferay.portlet.social.NoSuchEquityUserException;
192    
193            /**
194            * Returns the social equity users before and after the current social equity user in the ordered set where groupId = &#63;.
195            *
196            * <p>
197            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
198            * </p>
199            *
200            * @param equityUserId the primary key of the current social equity user
201            * @param groupId the group ID
202            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
203            * @return the previous, current, and next social equity user
204            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a social equity user with the primary key could not be found
205            * @throws SystemException if a system exception occurred
206            */
207            public com.liferay.portlet.social.model.SocialEquityUser[] findByGroupId_PrevAndNext(
208                    long equityUserId, long groupId,
209                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
210                    throws com.liferay.portal.kernel.exception.SystemException,
211                            com.liferay.portlet.social.NoSuchEquityUserException;
212    
213            /**
214            * Returns all the social equity users where groupId = &#63;.
215            *
216            * @param groupId the group ID
217            * @return the matching social equity users
218            * @throws SystemException if a system exception occurred
219            */
220            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByGroupRanked(
221                    long groupId)
222                    throws com.liferay.portal.kernel.exception.SystemException;
223    
224            /**
225            * Returns a range of all the social equity users where groupId = &#63;.
226            *
227            * <p>
228            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
229            * </p>
230            *
231            * @param groupId the group ID
232            * @param start the lower bound of the range of social equity users
233            * @param end the upper bound of the range of social equity users (not inclusive)
234            * @return the range of matching social equity users
235            * @throws SystemException if a system exception occurred
236            */
237            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByGroupRanked(
238                    long groupId, int start, int end)
239                    throws com.liferay.portal.kernel.exception.SystemException;
240    
241            /**
242            * Returns an ordered range of all the social equity users where groupId = &#63;.
243            *
244            * <p>
245            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
246            * </p>
247            *
248            * @param groupId the group ID
249            * @param start the lower bound of the range of social equity users
250            * @param end the upper bound of the range of social equity users (not inclusive)
251            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
252            * @return the ordered range of matching social equity users
253            * @throws SystemException if a system exception occurred
254            */
255            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByGroupRanked(
256                    long groupId, int start, int end,
257                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
258                    throws com.liferay.portal.kernel.exception.SystemException;
259    
260            /**
261            * Returns the first social equity user in the ordered set where groupId = &#63;.
262            *
263            * <p>
264            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
265            * </p>
266            *
267            * @param groupId the group ID
268            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
269            * @return the first matching social equity user
270            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
271            * @throws SystemException if a system exception occurred
272            */
273            public com.liferay.portlet.social.model.SocialEquityUser findByGroupRanked_First(
274                    long groupId,
275                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
276                    throws com.liferay.portal.kernel.exception.SystemException,
277                            com.liferay.portlet.social.NoSuchEquityUserException;
278    
279            /**
280            * Returns the last social equity user in the ordered set where groupId = &#63;.
281            *
282            * <p>
283            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
284            * </p>
285            *
286            * @param groupId the group ID
287            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
288            * @return the last matching social equity user
289            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
290            * @throws SystemException if a system exception occurred
291            */
292            public com.liferay.portlet.social.model.SocialEquityUser findByGroupRanked_Last(
293                    long groupId,
294                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
295                    throws com.liferay.portal.kernel.exception.SystemException,
296                            com.liferay.portlet.social.NoSuchEquityUserException;
297    
298            /**
299            * Returns the social equity users before and after the current social equity user in the ordered set where groupId = &#63;.
300            *
301            * <p>
302            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
303            * </p>
304            *
305            * @param equityUserId the primary key of the current social equity user
306            * @param groupId the group ID
307            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
308            * @return the previous, current, and next social equity user
309            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a social equity user with the primary key could not be found
310            * @throws SystemException if a system exception occurred
311            */
312            public com.liferay.portlet.social.model.SocialEquityUser[] findByGroupRanked_PrevAndNext(
313                    long equityUserId, long groupId,
314                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
315                    throws com.liferay.portal.kernel.exception.SystemException,
316                            com.liferay.portlet.social.NoSuchEquityUserException;
317    
318            /**
319            * Returns all the social equity users where userId = &#63;.
320            *
321            * @param userId the user ID
322            * @return the matching social equity users
323            * @throws SystemException if a system exception occurred
324            */
325            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByUserId(
326                    long userId) throws com.liferay.portal.kernel.exception.SystemException;
327    
328            /**
329            * Returns a range of all the social equity users where userId = &#63;.
330            *
331            * <p>
332            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
333            * </p>
334            *
335            * @param userId the user ID
336            * @param start the lower bound of the range of social equity users
337            * @param end the upper bound of the range of social equity users (not inclusive)
338            * @return the range of matching social equity users
339            * @throws SystemException if a system exception occurred
340            */
341            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByUserId(
342                    long userId, int start, int end)
343                    throws com.liferay.portal.kernel.exception.SystemException;
344    
345            /**
346            * Returns an ordered range of all the social equity users where userId = &#63;.
347            *
348            * <p>
349            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
350            * </p>
351            *
352            * @param userId the user ID
353            * @param start the lower bound of the range of social equity users
354            * @param end the upper bound of the range of social equity users (not inclusive)
355            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
356            * @return the ordered range of matching social equity users
357            * @throws SystemException if a system exception occurred
358            */
359            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByUserId(
360                    long userId, int start, int end,
361                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    
364            /**
365            * Returns the first social equity user in the ordered set where userId = &#63;.
366            *
367            * <p>
368            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
369            * </p>
370            *
371            * @param userId the user ID
372            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
373            * @return the first matching social equity user
374            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
375            * @throws SystemException if a system exception occurred
376            */
377            public com.liferay.portlet.social.model.SocialEquityUser findByUserId_First(
378                    long userId,
379                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
380                    throws com.liferay.portal.kernel.exception.SystemException,
381                            com.liferay.portlet.social.NoSuchEquityUserException;
382    
383            /**
384            * Returns the last social equity user in the ordered set where userId = &#63;.
385            *
386            * <p>
387            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
388            * </p>
389            *
390            * @param userId the user ID
391            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
392            * @return the last matching social equity user
393            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
394            * @throws SystemException if a system exception occurred
395            */
396            public com.liferay.portlet.social.model.SocialEquityUser findByUserId_Last(
397                    long userId,
398                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
399                    throws com.liferay.portal.kernel.exception.SystemException,
400                            com.liferay.portlet.social.NoSuchEquityUserException;
401    
402            /**
403            * Returns the social equity users before and after the current social equity user in the ordered set where userId = &#63;.
404            *
405            * <p>
406            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
407            * </p>
408            *
409            * @param equityUserId the primary key of the current social equity user
410            * @param userId the user ID
411            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
412            * @return the previous, current, and next social equity user
413            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a social equity user with the primary key could not be found
414            * @throws SystemException if a system exception occurred
415            */
416            public com.liferay.portlet.social.model.SocialEquityUser[] findByUserId_PrevAndNext(
417                    long equityUserId, long userId,
418                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
419                    throws com.liferay.portal.kernel.exception.SystemException,
420                            com.liferay.portlet.social.NoSuchEquityUserException;
421    
422            /**
423            * Returns all the social equity users where rank = &#63;.
424            *
425            * @param rank the rank
426            * @return the matching social equity users
427            * @throws SystemException if a system exception occurred
428            */
429            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByRank(
430                    int rank) throws com.liferay.portal.kernel.exception.SystemException;
431    
432            /**
433            * Returns a range of all the social equity users where rank = &#63;.
434            *
435            * <p>
436            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
437            * </p>
438            *
439            * @param rank the rank
440            * @param start the lower bound of the range of social equity users
441            * @param end the upper bound of the range of social equity users (not inclusive)
442            * @return the range of matching social equity users
443            * @throws SystemException if a system exception occurred
444            */
445            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByRank(
446                    int rank, int start, int end)
447                    throws com.liferay.portal.kernel.exception.SystemException;
448    
449            /**
450            * Returns an ordered range of all the social equity users where rank = &#63;.
451            *
452            * <p>
453            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
454            * </p>
455            *
456            * @param rank the rank
457            * @param start the lower bound of the range of social equity users
458            * @param end the upper bound of the range of social equity users (not inclusive)
459            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
460            * @return the ordered range of matching social equity users
461            * @throws SystemException if a system exception occurred
462            */
463            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByRank(
464                    int rank, int start, int end,
465                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
466                    throws com.liferay.portal.kernel.exception.SystemException;
467    
468            /**
469            * Returns the first social equity user in the ordered set where rank = &#63;.
470            *
471            * <p>
472            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
473            * </p>
474            *
475            * @param rank the rank
476            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
477            * @return the first matching social equity user
478            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
479            * @throws SystemException if a system exception occurred
480            */
481            public com.liferay.portlet.social.model.SocialEquityUser findByRank_First(
482                    int rank,
483                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
484                    throws com.liferay.portal.kernel.exception.SystemException,
485                            com.liferay.portlet.social.NoSuchEquityUserException;
486    
487            /**
488            * Returns the last social equity user in the ordered set where rank = &#63;.
489            *
490            * <p>
491            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
492            * </p>
493            *
494            * @param rank the rank
495            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
496            * @return the last matching social equity user
497            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
498            * @throws SystemException if a system exception occurred
499            */
500            public com.liferay.portlet.social.model.SocialEquityUser findByRank_Last(
501                    int rank,
502                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
503                    throws com.liferay.portal.kernel.exception.SystemException,
504                            com.liferay.portlet.social.NoSuchEquityUserException;
505    
506            /**
507            * Returns the social equity users before and after the current social equity user in the ordered set where rank = &#63;.
508            *
509            * <p>
510            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
511            * </p>
512            *
513            * @param equityUserId the primary key of the current social equity user
514            * @param rank the rank
515            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
516            * @return the previous, current, and next social equity user
517            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a social equity user with the primary key could not be found
518            * @throws SystemException if a system exception occurred
519            */
520            public com.liferay.portlet.social.model.SocialEquityUser[] findByRank_PrevAndNext(
521                    long equityUserId, int rank,
522                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
523                    throws com.liferay.portal.kernel.exception.SystemException,
524                            com.liferay.portlet.social.NoSuchEquityUserException;
525    
526            /**
527            * Returns the social equity user where groupId = &#63; and userId = &#63; or throws a {@link com.liferay.portlet.social.NoSuchEquityUserException} if it could not be found.
528            *
529            * @param groupId the group ID
530            * @param userId the user ID
531            * @return the matching social equity user
532            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
533            * @throws SystemException if a system exception occurred
534            */
535            public com.liferay.portlet.social.model.SocialEquityUser findByG_U(
536                    long groupId, long userId)
537                    throws com.liferay.portal.kernel.exception.SystemException,
538                            com.liferay.portlet.social.NoSuchEquityUserException;
539    
540            /**
541            * Returns the social equity user where groupId = &#63; and userId = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
542            *
543            * @param groupId the group ID
544            * @param userId the user ID
545            * @return the matching social equity user, or <code>null</code> if a matching social equity user could not be found
546            * @throws SystemException if a system exception occurred
547            */
548            public com.liferay.portlet.social.model.SocialEquityUser fetchByG_U(
549                    long groupId, long userId)
550                    throws com.liferay.portal.kernel.exception.SystemException;
551    
552            /**
553            * Returns the social equity user where groupId = &#63; and userId = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
554            *
555            * @param groupId the group ID
556            * @param userId the user ID
557            * @param retrieveFromCache whether to use the finder cache
558            * @return the matching social equity user, or <code>null</code> if a matching social equity user could not be found
559            * @throws SystemException if a system exception occurred
560            */
561            public com.liferay.portlet.social.model.SocialEquityUser fetchByG_U(
562                    long groupId, long userId, boolean retrieveFromCache)
563                    throws com.liferay.portal.kernel.exception.SystemException;
564    
565            /**
566            * Returns all the social equity users where groupId = &#63; and rank = &#63;.
567            *
568            * @param groupId the group ID
569            * @param rank the rank
570            * @return the matching social equity users
571            * @throws SystemException if a system exception occurred
572            */
573            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByG_R(
574                    long groupId, int rank)
575                    throws com.liferay.portal.kernel.exception.SystemException;
576    
577            /**
578            * Returns a range of all the social equity users where groupId = &#63; and rank = &#63;.
579            *
580            * <p>
581            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
582            * </p>
583            *
584            * @param groupId the group ID
585            * @param rank the rank
586            * @param start the lower bound of the range of social equity users
587            * @param end the upper bound of the range of social equity users (not inclusive)
588            * @return the range of matching social equity users
589            * @throws SystemException if a system exception occurred
590            */
591            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByG_R(
592                    long groupId, int rank, int start, int end)
593                    throws com.liferay.portal.kernel.exception.SystemException;
594    
595            /**
596            * Returns an ordered range of all the social equity users where groupId = &#63; and rank = &#63;.
597            *
598            * <p>
599            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
600            * </p>
601            *
602            * @param groupId the group ID
603            * @param rank the rank
604            * @param start the lower bound of the range of social equity users
605            * @param end the upper bound of the range of social equity users (not inclusive)
606            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
607            * @return the ordered range of matching social equity users
608            * @throws SystemException if a system exception occurred
609            */
610            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findByG_R(
611                    long groupId, int rank, int start, int end,
612                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
613                    throws com.liferay.portal.kernel.exception.SystemException;
614    
615            /**
616            * Returns the first social equity user in the ordered set where groupId = &#63; and rank = &#63;.
617            *
618            * <p>
619            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
620            * </p>
621            *
622            * @param groupId the group ID
623            * @param rank the rank
624            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
625            * @return the first matching social equity user
626            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
627            * @throws SystemException if a system exception occurred
628            */
629            public com.liferay.portlet.social.model.SocialEquityUser findByG_R_First(
630                    long groupId, int rank,
631                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
632                    throws com.liferay.portal.kernel.exception.SystemException,
633                            com.liferay.portlet.social.NoSuchEquityUserException;
634    
635            /**
636            * Returns the last social equity user in the ordered set where groupId = &#63; and rank = &#63;.
637            *
638            * <p>
639            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
640            * </p>
641            *
642            * @param groupId the group ID
643            * @param rank the rank
644            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
645            * @return the last matching social equity user
646            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a matching social equity user could not be found
647            * @throws SystemException if a system exception occurred
648            */
649            public com.liferay.portlet.social.model.SocialEquityUser findByG_R_Last(
650                    long groupId, int rank,
651                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
652                    throws com.liferay.portal.kernel.exception.SystemException,
653                            com.liferay.portlet.social.NoSuchEquityUserException;
654    
655            /**
656            * Returns the social equity users before and after the current social equity user in the ordered set where groupId = &#63; and rank = &#63;.
657            *
658            * <p>
659            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
660            * </p>
661            *
662            * @param equityUserId the primary key of the current social equity user
663            * @param groupId the group ID
664            * @param rank the rank
665            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
666            * @return the previous, current, and next social equity user
667            * @throws com.liferay.portlet.social.NoSuchEquityUserException if a social equity user with the primary key could not be found
668            * @throws SystemException if a system exception occurred
669            */
670            public com.liferay.portlet.social.model.SocialEquityUser[] findByG_R_PrevAndNext(
671                    long equityUserId, long groupId, int rank,
672                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
673                    throws com.liferay.portal.kernel.exception.SystemException,
674                            com.liferay.portlet.social.NoSuchEquityUserException;
675    
676            /**
677            * Returns all the social equity users.
678            *
679            * @return the social equity users
680            * @throws SystemException if a system exception occurred
681            */
682            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findAll()
683                    throws com.liferay.portal.kernel.exception.SystemException;
684    
685            /**
686            * Returns a range of all the social equity users.
687            *
688            * <p>
689            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
690            * </p>
691            *
692            * @param start the lower bound of the range of social equity users
693            * @param end the upper bound of the range of social equity users (not inclusive)
694            * @return the range of social equity users
695            * @throws SystemException if a system exception occurred
696            */
697            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findAll(
698                    int start, int end)
699                    throws com.liferay.portal.kernel.exception.SystemException;
700    
701            /**
702            * Returns an ordered range of all the social equity users.
703            *
704            * <p>
705            * Useful when paginating results. Returns a maximum of <code>end - start</code> instances. <code>start</code> and <code>end</code> are not primary keys, they are indexes in the result set. Thus, <code>0</code> refers to the first result in the set. Setting both <code>start</code> and <code>end</code> to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
706            * </p>
707            *
708            * @param start the lower bound of the range of social equity users
709            * @param end the upper bound of the range of social equity users (not inclusive)
710            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
711            * @return the ordered range of social equity users
712            * @throws SystemException if a system exception occurred
713            */
714            public java.util.List<com.liferay.portlet.social.model.SocialEquityUser> findAll(
715                    int start, int end,
716                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
717                    throws com.liferay.portal.kernel.exception.SystemException;
718    
719            /**
720            * Removes all the social equity users where groupId = &#63; from the database.
721            *
722            * @param groupId the group ID
723            * @throws SystemException if a system exception occurred
724            */
725            public void removeByGroupId(long groupId)
726                    throws com.liferay.portal.kernel.exception.SystemException;
727    
728            /**
729            * Removes all the social equity users where groupId = &#63; from the database.
730            *
731            * @param groupId the group ID
732            * @throws SystemException if a system exception occurred
733            */
734            public void removeByGroupRanked(long groupId)
735                    throws com.liferay.portal.kernel.exception.SystemException;
736    
737            /**
738            * Removes all the social equity users where userId = &#63; from the database.
739            *
740            * @param userId the user ID
741            * @throws SystemException if a system exception occurred
742            */
743            public void removeByUserId(long userId)
744                    throws com.liferay.portal.kernel.exception.SystemException;
745    
746            /**
747            * Removes all the social equity users where rank = &#63; from the database.
748            *
749            * @param rank the rank
750            * @throws SystemException if a system exception occurred
751            */
752            public void removeByRank(int rank)
753                    throws com.liferay.portal.kernel.exception.SystemException;
754    
755            /**
756            * Removes the social equity user where groupId = &#63; and userId = &#63; from the database.
757            *
758            * @param groupId the group ID
759            * @param userId the user ID
760            * @throws SystemException if a system exception occurred
761            */
762            public void removeByG_U(long groupId, long userId)
763                    throws com.liferay.portal.kernel.exception.SystemException,
764                            com.liferay.portlet.social.NoSuchEquityUserException;
765    
766            /**
767            * Removes all the social equity users where groupId = &#63; and rank = &#63; from the database.
768            *
769            * @param groupId the group ID
770            * @param rank the rank
771            * @throws SystemException if a system exception occurred
772            */
773            public void removeByG_R(long groupId, int rank)
774                    throws com.liferay.portal.kernel.exception.SystemException;
775    
776            /**
777            * Removes all the social equity users from the database.
778            *
779            * @throws SystemException if a system exception occurred
780            */
781            public void removeAll()
782                    throws com.liferay.portal.kernel.exception.SystemException;
783    
784            /**
785            * Returns the number of social equity users where groupId = &#63;.
786            *
787            * @param groupId the group ID
788            * @return the number of matching social equity users
789            * @throws SystemException if a system exception occurred
790            */
791            public int countByGroupId(long groupId)
792                    throws com.liferay.portal.kernel.exception.SystemException;
793    
794            /**
795            * Returns the number of social equity users where groupId = &#63;.
796            *
797            * @param groupId the group ID
798            * @return the number of matching social equity users
799            * @throws SystemException if a system exception occurred
800            */
801            public int countByGroupRanked(long groupId)
802                    throws com.liferay.portal.kernel.exception.SystemException;
803    
804            /**
805            * Returns the number of social equity users where userId = &#63;.
806            *
807            * @param userId the user ID
808            * @return the number of matching social equity users
809            * @throws SystemException if a system exception occurred
810            */
811            public int countByUserId(long userId)
812                    throws com.liferay.portal.kernel.exception.SystemException;
813    
814            /**
815            * Returns the number of social equity users where rank = &#63;.
816            *
817            * @param rank the rank
818            * @return the number of matching social equity users
819            * @throws SystemException if a system exception occurred
820            */
821            public int countByRank(int rank)
822                    throws com.liferay.portal.kernel.exception.SystemException;
823    
824            /**
825            * Returns the number of social equity users where groupId = &#63; and userId = &#63;.
826            *
827            * @param groupId the group ID
828            * @param userId the user ID
829            * @return the number of matching social equity users
830            * @throws SystemException if a system exception occurred
831            */
832            public int countByG_U(long groupId, long userId)
833                    throws com.liferay.portal.kernel.exception.SystemException;
834    
835            /**
836            * Returns the number of social equity users where groupId = &#63; and rank = &#63;.
837            *
838            * @param groupId the group ID
839            * @param rank the rank
840            * @return the number of matching social equity users
841            * @throws SystemException if a system exception occurred
842            */
843            public int countByG_R(long groupId, int rank)
844                    throws com.liferay.portal.kernel.exception.SystemException;
845    
846            /**
847            * Returns the number of social equity users.
848            *
849            * @return the number of social equity users
850            * @throws SystemException if a system exception occurred
851            */
852            public int countAll()
853                    throws com.liferay.portal.kernel.exception.SystemException;
854    
855            public SocialEquityUser remove(SocialEquityUser socialEquityUser)
856                    throws SystemException;
857    }