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