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.social.service.persistence;
016    
017    import com.liferay.portal.service.persistence.BasePersistence;
018    
019    import com.liferay.portlet.social.model.SocialActivityLimit;
020    
021    /**
022     * The persistence interface for the social activity limit service.
023     *
024     * <p>
025     * Caching information and settings can be found in <code>portal.properties</code>
026     * </p>
027     *
028     * @author Brian Wing Shun Chan
029     * @see SocialActivityLimitPersistenceImpl
030     * @see SocialActivityLimitUtil
031     * @generated
032     */
033    public interface SocialActivityLimitPersistence extends BasePersistence<SocialActivityLimit> {
034            /*
035             * NOTE FOR DEVELOPERS:
036             *
037             * Never modify or reference this interface directly. Always use {@link SocialActivityLimitUtil} to access the social activity limit persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
038             */
039    
040            /**
041            * Caches the social activity limit in the entity cache if it is enabled.
042            *
043            * @param socialActivityLimit the social activity limit
044            */
045            public void cacheResult(
046                    com.liferay.portlet.social.model.SocialActivityLimit socialActivityLimit);
047    
048            /**
049            * Caches the social activity limits in the entity cache if it is enabled.
050            *
051            * @param socialActivityLimits the social activity limits
052            */
053            public void cacheResult(
054                    java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> socialActivityLimits);
055    
056            /**
057            * Creates a new social activity limit with the primary key. Does not add the social activity limit to the database.
058            *
059            * @param activityLimitId the primary key for the new social activity limit
060            * @return the new social activity limit
061            */
062            public com.liferay.portlet.social.model.SocialActivityLimit create(
063                    long activityLimitId);
064    
065            /**
066            * Removes the social activity limit with the primary key from the database. Also notifies the appropriate model listeners.
067            *
068            * @param activityLimitId the primary key of the social activity limit
069            * @return the social activity limit that was removed
070            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a social activity limit with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public com.liferay.portlet.social.model.SocialActivityLimit remove(
074                    long activityLimitId)
075                    throws com.liferay.portal.kernel.exception.SystemException,
076                            com.liferay.portlet.social.NoSuchActivityLimitException;
077    
078            public com.liferay.portlet.social.model.SocialActivityLimit updateImpl(
079                    com.liferay.portlet.social.model.SocialActivityLimit socialActivityLimit,
080                    boolean merge)
081                    throws com.liferay.portal.kernel.exception.SystemException;
082    
083            /**
084            * Returns the social activity limit with the primary key or throws a {@link com.liferay.portlet.social.NoSuchActivityLimitException} if it could not be found.
085            *
086            * @param activityLimitId the primary key of the social activity limit
087            * @return the social activity limit
088            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a social activity limit with the primary key could not be found
089            * @throws SystemException if a system exception occurred
090            */
091            public com.liferay.portlet.social.model.SocialActivityLimit findByPrimaryKey(
092                    long activityLimitId)
093                    throws com.liferay.portal.kernel.exception.SystemException,
094                            com.liferay.portlet.social.NoSuchActivityLimitException;
095    
096            /**
097            * Returns the social activity limit with the primary key or returns <code>null</code> if it could not be found.
098            *
099            * @param activityLimitId the primary key of the social activity limit
100            * @return the social activity limit, or <code>null</code> if a social activity limit with the primary key could not be found
101            * @throws SystemException if a system exception occurred
102            */
103            public com.liferay.portlet.social.model.SocialActivityLimit fetchByPrimaryKey(
104                    long activityLimitId)
105                    throws com.liferay.portal.kernel.exception.SystemException;
106    
107            /**
108            * Returns all the social activity limits where classNameId = &#63; and classPK = &#63;.
109            *
110            * @param classNameId the class name ID
111            * @param classPK the class p k
112            * @return the matching social activity limits
113            * @throws SystemException if a system exception occurred
114            */
115            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findByC_C(
116                    long classNameId, long classPK)
117                    throws com.liferay.portal.kernel.exception.SystemException;
118    
119            /**
120            * Returns a range of all the social activity limits where classNameId = &#63; and classPK = &#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 classNameId the class name ID
127            * @param classPK the class p k
128            * @param start the lower bound of the range of social activity limits
129            * @param end the upper bound of the range of social activity limits (not inclusive)
130            * @return the range of matching social activity limits
131            * @throws SystemException if a system exception occurred
132            */
133            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findByC_C(
134                    long classNameId, long classPK, int start, int end)
135                    throws com.liferay.portal.kernel.exception.SystemException;
136    
137            /**
138            * Returns an ordered range of all the social activity limits where classNameId = &#63; and classPK = &#63;.
139            *
140            * <p>
141            * 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.
142            * </p>
143            *
144            * @param classNameId the class name ID
145            * @param classPK the class p k
146            * @param start the lower bound of the range of social activity limits
147            * @param end the upper bound of the range of social activity limits (not inclusive)
148            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
149            * @return the ordered range of matching social activity limits
150            * @throws SystemException if a system exception occurred
151            */
152            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findByC_C(
153                    long classNameId, long classPK, int start, int end,
154                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
155                    throws com.liferay.portal.kernel.exception.SystemException;
156    
157            /**
158            * Returns the first social activity limit in the ordered set where classNameId = &#63; and classPK = &#63;.
159            *
160            * <p>
161            * 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.
162            * </p>
163            *
164            * @param classNameId the class name ID
165            * @param classPK the class p k
166            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
167            * @return the first matching social activity limit
168            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a matching social activity limit could not be found
169            * @throws SystemException if a system exception occurred
170            */
171            public com.liferay.portlet.social.model.SocialActivityLimit findByC_C_First(
172                    long classNameId, long classPK,
173                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
174                    throws com.liferay.portal.kernel.exception.SystemException,
175                            com.liferay.portlet.social.NoSuchActivityLimitException;
176    
177            /**
178            * Returns the last social activity limit in the ordered set where classNameId = &#63; and classPK = &#63;.
179            *
180            * <p>
181            * 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.
182            * </p>
183            *
184            * @param classNameId the class name ID
185            * @param classPK the class p k
186            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
187            * @return the last matching social activity limit
188            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a matching social activity limit could not be found
189            * @throws SystemException if a system exception occurred
190            */
191            public com.liferay.portlet.social.model.SocialActivityLimit findByC_C_Last(
192                    long classNameId, long classPK,
193                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
194                    throws com.liferay.portal.kernel.exception.SystemException,
195                            com.liferay.portlet.social.NoSuchActivityLimitException;
196    
197            /**
198            * Returns the social activity limits before and after the current social activity limit in the ordered set where classNameId = &#63; and classPK = &#63;.
199            *
200            * <p>
201            * 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.
202            * </p>
203            *
204            * @param activityLimitId the primary key of the current social activity limit
205            * @param classNameId the class name ID
206            * @param classPK the class p k
207            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
208            * @return the previous, current, and next social activity limit
209            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a social activity limit with the primary key could not be found
210            * @throws SystemException if a system exception occurred
211            */
212            public com.liferay.portlet.social.model.SocialActivityLimit[] findByC_C_PrevAndNext(
213                    long activityLimitId, long classNameId, long classPK,
214                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
215                    throws com.liferay.portal.kernel.exception.SystemException,
216                            com.liferay.portlet.social.NoSuchActivityLimitException;
217    
218            /**
219            * Returns the social activity limit where groupId = &#63; and userId = &#63; and classNameId = &#63; and classPK = &#63; and activityType = &#63; and activityCounterName = &#63; or throws a {@link com.liferay.portlet.social.NoSuchActivityLimitException} if it could not be found.
220            *
221            * @param groupId the group ID
222            * @param userId the user ID
223            * @param classNameId the class name ID
224            * @param classPK the class p k
225            * @param activityType the activity type
226            * @param activityCounterName the activity counter name
227            * @return the matching social activity limit
228            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a matching social activity limit could not be found
229            * @throws SystemException if a system exception occurred
230            */
231            public com.liferay.portlet.social.model.SocialActivityLimit findByG_U_C_C_A_A(
232                    long groupId, long userId, long classNameId, long classPK,
233                    int activityType, java.lang.String activityCounterName)
234                    throws com.liferay.portal.kernel.exception.SystemException,
235                            com.liferay.portlet.social.NoSuchActivityLimitException;
236    
237            /**
238            * Returns the social activity limit where groupId = &#63; and userId = &#63; and classNameId = &#63; and classPK = &#63; and activityType = &#63; and activityCounterName = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
239            *
240            * @param groupId the group ID
241            * @param userId the user ID
242            * @param classNameId the class name ID
243            * @param classPK the class p k
244            * @param activityType the activity type
245            * @param activityCounterName the activity counter name
246            * @return the matching social activity limit, or <code>null</code> if a matching social activity limit could not be found
247            * @throws SystemException if a system exception occurred
248            */
249            public com.liferay.portlet.social.model.SocialActivityLimit fetchByG_U_C_C_A_A(
250                    long groupId, long userId, long classNameId, long classPK,
251                    int activityType, java.lang.String activityCounterName)
252                    throws com.liferay.portal.kernel.exception.SystemException;
253    
254            /**
255            * Returns the social activity limit where groupId = &#63; and userId = &#63; and classNameId = &#63; and classPK = &#63; and activityType = &#63; and activityCounterName = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
256            *
257            * @param groupId the group ID
258            * @param userId the user ID
259            * @param classNameId the class name ID
260            * @param classPK the class p k
261            * @param activityType the activity type
262            * @param activityCounterName the activity counter name
263            * @param retrieveFromCache whether to use the finder cache
264            * @return the matching social activity limit, or <code>null</code> if a matching social activity limit could not be found
265            * @throws SystemException if a system exception occurred
266            */
267            public com.liferay.portlet.social.model.SocialActivityLimit fetchByG_U_C_C_A_A(
268                    long groupId, long userId, long classNameId, long classPK,
269                    int activityType, java.lang.String activityCounterName,
270                    boolean retrieveFromCache)
271                    throws com.liferay.portal.kernel.exception.SystemException;
272    
273            /**
274            * Returns all the social activity limits.
275            *
276            * @return the social activity limits
277            * @throws SystemException if a system exception occurred
278            */
279            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findAll()
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            /**
283            * Returns a range of all the social activity limits.
284            *
285            * <p>
286            * 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.
287            * </p>
288            *
289            * @param start the lower bound of the range of social activity limits
290            * @param end the upper bound of the range of social activity limits (not inclusive)
291            * @return the range of social activity limits
292            * @throws SystemException if a system exception occurred
293            */
294            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findAll(
295                    int start, int end)
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            /**
299            * Returns an ordered range of all the social activity limits.
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 start the lower bound of the range of social activity limits
306            * @param end the upper bound of the range of social activity limits (not inclusive)
307            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
308            * @return the ordered range of social activity limits
309            * @throws SystemException if a system exception occurred
310            */
311            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findAll(
312                    int start, int end,
313                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            /**
317            * Removes all the social activity limits where classNameId = &#63; and classPK = &#63; from the database.
318            *
319            * @param classNameId the class name ID
320            * @param classPK the class p k
321            * @throws SystemException if a system exception occurred
322            */
323            public void removeByC_C(long classNameId, long classPK)
324                    throws com.liferay.portal.kernel.exception.SystemException;
325    
326            /**
327            * Removes the social activity limit where groupId = &#63; and userId = &#63; and classNameId = &#63; and classPK = &#63; and activityType = &#63; and activityCounterName = &#63; from the database.
328            *
329            * @param groupId the group ID
330            * @param userId the user ID
331            * @param classNameId the class name ID
332            * @param classPK the class p k
333            * @param activityType the activity type
334            * @param activityCounterName the activity counter name
335            * @throws SystemException if a system exception occurred
336            */
337            public void removeByG_U_C_C_A_A(long groupId, long userId,
338                    long classNameId, long classPK, int activityType,
339                    java.lang.String activityCounterName)
340                    throws com.liferay.portal.kernel.exception.SystemException,
341                            com.liferay.portlet.social.NoSuchActivityLimitException;
342    
343            /**
344            * Removes all the social activity limits from the database.
345            *
346            * @throws SystemException if a system exception occurred
347            */
348            public void removeAll()
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            /**
352            * Returns the number of social activity limits where classNameId = &#63; and classPK = &#63;.
353            *
354            * @param classNameId the class name ID
355            * @param classPK the class p k
356            * @return the number of matching social activity limits
357            * @throws SystemException if a system exception occurred
358            */
359            public int countByC_C(long classNameId, long classPK)
360                    throws com.liferay.portal.kernel.exception.SystemException;
361    
362            /**
363            * Returns the number of social activity limits where groupId = &#63; and userId = &#63; and classNameId = &#63; and classPK = &#63; and activityType = &#63; and activityCounterName = &#63;.
364            *
365            * @param groupId the group ID
366            * @param userId the user ID
367            * @param classNameId the class name ID
368            * @param classPK the class p k
369            * @param activityType the activity type
370            * @param activityCounterName the activity counter name
371            * @return the number of matching social activity limits
372            * @throws SystemException if a system exception occurred
373            */
374            public int countByG_U_C_C_A_A(long groupId, long userId, long classNameId,
375                    long classPK, int activityType, java.lang.String activityCounterName)
376                    throws com.liferay.portal.kernel.exception.SystemException;
377    
378            /**
379            * Returns the number of social activity limits.
380            *
381            * @return the number of social activity limits
382            * @throws SystemException if a system exception occurred
383            */
384            public int countAll()
385                    throws com.liferay.portal.kernel.exception.SystemException;
386    }