001    /**
002     * Copyright (c) 2000-2013 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            * @param classNameId the class name ID
161            * @param classPK the class p k
162            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
163            * @return the first matching social activity limit
164            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a matching social activity limit could not be found
165            * @throws SystemException if a system exception occurred
166            */
167            public com.liferay.portlet.social.model.SocialActivityLimit findByC_C_First(
168                    long classNameId, long classPK,
169                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
170                    throws com.liferay.portal.kernel.exception.SystemException,
171                            com.liferay.portlet.social.NoSuchActivityLimitException;
172    
173            /**
174            * Returns the first social activity limit in the ordered set where classNameId = &#63; and classPK = &#63;.
175            *
176            * @param classNameId the class name ID
177            * @param classPK the class p k
178            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
179            * @return the first matching social activity limit, or <code>null</code> if a matching social activity limit could not be found
180            * @throws SystemException if a system exception occurred
181            */
182            public com.liferay.portlet.social.model.SocialActivityLimit fetchByC_C_First(
183                    long classNameId, long classPK,
184                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
185                    throws com.liferay.portal.kernel.exception.SystemException;
186    
187            /**
188            * Returns the last social activity limit in the ordered set where classNameId = &#63; and classPK = &#63;.
189            *
190            * @param classNameId the class name ID
191            * @param classPK the class p k
192            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
193            * @return the last matching social activity limit
194            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a matching social activity limit could not be found
195            * @throws SystemException if a system exception occurred
196            */
197            public com.liferay.portlet.social.model.SocialActivityLimit findByC_C_Last(
198                    long classNameId, long classPK,
199                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
200                    throws com.liferay.portal.kernel.exception.SystemException,
201                            com.liferay.portlet.social.NoSuchActivityLimitException;
202    
203            /**
204            * Returns the last social activity limit in the ordered set where classNameId = &#63; and classPK = &#63;.
205            *
206            * @param classNameId the class name ID
207            * @param classPK the class p k
208            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
209            * @return the last matching social activity limit, or <code>null</code> if a matching social activity limit could not be found
210            * @throws SystemException if a system exception occurred
211            */
212            public com.liferay.portlet.social.model.SocialActivityLimit fetchByC_C_Last(
213                    long classNameId, long classPK,
214                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
215                    throws com.liferay.portal.kernel.exception.SystemException;
216    
217            /**
218            * Returns the social activity limits before and after the current social activity limit in the ordered set where classNameId = &#63; and classPK = &#63;.
219            *
220            * @param activityLimitId the primary key of the current social activity limit
221            * @param classNameId the class name ID
222            * @param classPK the class p k
223            * @param orderByComparator the comparator to order the set by (optionally <code>null</code>)
224            * @return the previous, current, and next social activity limit
225            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a social activity limit with the primary key could not be found
226            * @throws SystemException if a system exception occurred
227            */
228            public com.liferay.portlet.social.model.SocialActivityLimit[] findByC_C_PrevAndNext(
229                    long activityLimitId, long classNameId, long classPK,
230                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
231                    throws com.liferay.portal.kernel.exception.SystemException,
232                            com.liferay.portlet.social.NoSuchActivityLimitException;
233    
234            /**
235            * 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.
236            *
237            * @param groupId the group ID
238            * @param userId the user ID
239            * @param classNameId the class name ID
240            * @param classPK the class p k
241            * @param activityType the activity type
242            * @param activityCounterName the activity counter name
243            * @return the matching social activity limit
244            * @throws com.liferay.portlet.social.NoSuchActivityLimitException if a matching social activity limit could not be found
245            * @throws SystemException if a system exception occurred
246            */
247            public com.liferay.portlet.social.model.SocialActivityLimit findByG_U_C_C_A_A(
248                    long groupId, long userId, long classNameId, long classPK,
249                    int activityType, java.lang.String activityCounterName)
250                    throws com.liferay.portal.kernel.exception.SystemException,
251                            com.liferay.portlet.social.NoSuchActivityLimitException;
252    
253            /**
254            * 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.
255            *
256            * @param groupId the group ID
257            * @param userId the user ID
258            * @param classNameId the class name ID
259            * @param classPK the class p k
260            * @param activityType the activity type
261            * @param activityCounterName the activity counter name
262            * @return the matching social activity limit, or <code>null</code> if a matching social activity limit could not be found
263            * @throws SystemException if a system exception occurred
264            */
265            public com.liferay.portlet.social.model.SocialActivityLimit fetchByG_U_C_C_A_A(
266                    long groupId, long userId, long classNameId, long classPK,
267                    int activityType, java.lang.String activityCounterName)
268                    throws com.liferay.portal.kernel.exception.SystemException;
269    
270            /**
271            * 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.
272            *
273            * @param groupId the group ID
274            * @param userId the user ID
275            * @param classNameId the class name ID
276            * @param classPK the class p k
277            * @param activityType the activity type
278            * @param activityCounterName the activity counter name
279            * @param retrieveFromCache whether to use the finder cache
280            * @return the matching social activity limit, or <code>null</code> if a matching social activity limit could not be found
281            * @throws SystemException if a system exception occurred
282            */
283            public com.liferay.portlet.social.model.SocialActivityLimit fetchByG_U_C_C_A_A(
284                    long groupId, long userId, long classNameId, long classPK,
285                    int activityType, java.lang.String activityCounterName,
286                    boolean retrieveFromCache)
287                    throws com.liferay.portal.kernel.exception.SystemException;
288    
289            /**
290            * Returns all the social activity limits.
291            *
292            * @return the social activity limits
293            * @throws SystemException if a system exception occurred
294            */
295            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findAll()
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            /**
299            * Returns a 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            * @return the range of social activity limits
308            * @throws SystemException if a system exception occurred
309            */
310            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findAll(
311                    int start, int end)
312                    throws com.liferay.portal.kernel.exception.SystemException;
313    
314            /**
315            * Returns an ordered range of all the social activity limits.
316            *
317            * <p>
318            * 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.
319            * </p>
320            *
321            * @param start the lower bound of the range of social activity limits
322            * @param end the upper bound of the range of social activity limits (not inclusive)
323            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
324            * @return the ordered range of social activity limits
325            * @throws SystemException if a system exception occurred
326            */
327            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> findAll(
328                    int start, int end,
329                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
330                    throws com.liferay.portal.kernel.exception.SystemException;
331    
332            /**
333            * Removes all the social activity limits where classNameId = &#63; and classPK = &#63; from the database.
334            *
335            * @param classNameId the class name ID
336            * @param classPK the class p k
337            * @throws SystemException if a system exception occurred
338            */
339            public void removeByC_C(long classNameId, long classPK)
340                    throws com.liferay.portal.kernel.exception.SystemException;
341    
342            /**
343            * 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.
344            *
345            * @param groupId the group ID
346            * @param userId the user ID
347            * @param classNameId the class name ID
348            * @param classPK the class p k
349            * @param activityType the activity type
350            * @param activityCounterName the activity counter name
351            * @return the social activity limit that was removed
352            * @throws SystemException if a system exception occurred
353            */
354            public com.liferay.portlet.social.model.SocialActivityLimit removeByG_U_C_C_A_A(
355                    long groupId, long userId, long classNameId, long classPK,
356                    int activityType, java.lang.String activityCounterName)
357                    throws com.liferay.portal.kernel.exception.SystemException,
358                            com.liferay.portlet.social.NoSuchActivityLimitException;
359    
360            /**
361            * Removes all the social activity limits from the database.
362            *
363            * @throws SystemException if a system exception occurred
364            */
365            public void removeAll()
366                    throws com.liferay.portal.kernel.exception.SystemException;
367    
368            /**
369            * Returns the number of social activity limits where classNameId = &#63; and classPK = &#63;.
370            *
371            * @param classNameId the class name ID
372            * @param classPK the class p k
373            * @return the number of matching social activity limits
374            * @throws SystemException if a system exception occurred
375            */
376            public int countByC_C(long classNameId, long classPK)
377                    throws com.liferay.portal.kernel.exception.SystemException;
378    
379            /**
380            * 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;.
381            *
382            * @param groupId the group ID
383            * @param userId the user ID
384            * @param classNameId the class name ID
385            * @param classPK the class p k
386            * @param activityType the activity type
387            * @param activityCounterName the activity counter name
388            * @return the number of matching social activity limits
389            * @throws SystemException if a system exception occurred
390            */
391            public int countByG_U_C_C_A_A(long groupId, long userId, long classNameId,
392                    long classPK, int activityType, java.lang.String activityCounterName)
393                    throws com.liferay.portal.kernel.exception.SystemException;
394    
395            /**
396            * Returns the number of social activity limits.
397            *
398            * @return the number of social activity limits
399            * @throws SystemException if a system exception occurred
400            */
401            public int countAll()
402                    throws com.liferay.portal.kernel.exception.SystemException;
403    }