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.SocialEquityGroupSetting;
021    
022    /**
023     * The persistence interface for the social equity group 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 SocialEquityGroupSettingPersistenceImpl
031     * @see SocialEquityGroupSettingUtil
032     * @generated
033     */
034    public interface SocialEquityGroupSettingPersistence extends BasePersistence<SocialEquityGroupSetting> {
035            /*
036             * NOTE FOR DEVELOPERS:
037             *
038             * Never modify or reference this interface directly. Always use {@link SocialEquityGroupSettingUtil} to access the social equity group setting persistence. Modify <code>service.xml</code> and rerun ServiceBuilder to regenerate this interface.
039             */
040    
041            /**
042            * Caches the social equity group setting in the entity cache if it is enabled.
043            *
044            * @param socialEquityGroupSetting the social equity group setting
045            */
046            public void cacheResult(
047                    com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting);
048    
049            /**
050            * Caches the social equity group settings in the entity cache if it is enabled.
051            *
052            * @param socialEquityGroupSettings the social equity group settings
053            */
054            public void cacheResult(
055                    java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> socialEquityGroupSettings);
056    
057            /**
058            * Creates a new social equity group setting with the primary key. Does not add the social equity group setting to the database.
059            *
060            * @param equityGroupSettingId the primary key for the new social equity group setting
061            * @return the new social equity group setting
062            */
063            public com.liferay.portlet.social.model.SocialEquityGroupSetting create(
064                    long equityGroupSettingId);
065    
066            /**
067            * Removes the social equity group setting with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param equityGroupSettingId the primary key of the social equity group setting
070            * @return the social equity group setting that was removed
071            * @throws com.liferay.portlet.social.NoSuchEquityGroupSettingException if a social equity group 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.SocialEquityGroupSetting remove(
075                    long equityGroupSettingId)
076                    throws com.liferay.portal.kernel.exception.SystemException,
077                            com.liferay.portlet.social.NoSuchEquityGroupSettingException;
078    
079            public com.liferay.portlet.social.model.SocialEquityGroupSetting updateImpl(
080                    com.liferay.portlet.social.model.SocialEquityGroupSetting socialEquityGroupSetting,
081                    boolean merge)
082                    throws com.liferay.portal.kernel.exception.SystemException;
083    
084            /**
085            * Returns the social equity group setting with the primary key or throws a {@link com.liferay.portlet.social.NoSuchEquityGroupSettingException} if it could not be found.
086            *
087            * @param equityGroupSettingId the primary key of the social equity group setting
088            * @return the social equity group setting
089            * @throws com.liferay.portlet.social.NoSuchEquityGroupSettingException if a social equity group 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.SocialEquityGroupSetting findByPrimaryKey(
093                    long equityGroupSettingId)
094                    throws com.liferay.portal.kernel.exception.SystemException,
095                            com.liferay.portlet.social.NoSuchEquityGroupSettingException;
096    
097            /**
098            * Returns the social equity group setting with the primary key or returns <code>null</code> if it could not be found.
099            *
100            * @param equityGroupSettingId the primary key of the social equity group setting
101            * @return the social equity group setting, or <code>null</code> if a social equity group 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.SocialEquityGroupSetting fetchByPrimaryKey(
105                    long equityGroupSettingId)
106                    throws com.liferay.portal.kernel.exception.SystemException;
107    
108            /**
109            * Returns the social equity group setting where groupId = &#63; and classNameId = &#63; and type = &#63; or throws a {@link com.liferay.portlet.social.NoSuchEquityGroupSettingException} if it could not be found.
110            *
111            * @param groupId the group ID
112            * @param classNameId the class name ID
113            * @param type the type
114            * @return the matching social equity group setting
115            * @throws com.liferay.portlet.social.NoSuchEquityGroupSettingException if a matching social equity group setting could not be found
116            * @throws SystemException if a system exception occurred
117            */
118            public com.liferay.portlet.social.model.SocialEquityGroupSetting findByG_C_T(
119                    long groupId, long classNameId, int type)
120                    throws com.liferay.portal.kernel.exception.SystemException,
121                            com.liferay.portlet.social.NoSuchEquityGroupSettingException;
122    
123            /**
124            * Returns the social equity group setting where groupId = &#63; and classNameId = &#63; and type = &#63; or returns <code>null</code> if it could not be found. Uses the finder cache.
125            *
126            * @param groupId the group ID
127            * @param classNameId the class name ID
128            * @param type the type
129            * @return the matching social equity group setting, or <code>null</code> if a matching social equity group setting could not be found
130            * @throws SystemException if a system exception occurred
131            */
132            public com.liferay.portlet.social.model.SocialEquityGroupSetting fetchByG_C_T(
133                    long groupId, long classNameId, int type)
134                    throws com.liferay.portal.kernel.exception.SystemException;
135    
136            /**
137            * Returns the social equity group setting where groupId = &#63; and classNameId = &#63; and type = &#63; or returns <code>null</code> if it could not be found, optionally using the finder cache.
138            *
139            * @param groupId the group ID
140            * @param classNameId the class name ID
141            * @param type the type
142            * @param retrieveFromCache whether to use the finder cache
143            * @return the matching social equity group setting, or <code>null</code> if a matching social equity group setting could not be found
144            * @throws SystemException if a system exception occurred
145            */
146            public com.liferay.portlet.social.model.SocialEquityGroupSetting fetchByG_C_T(
147                    long groupId, long classNameId, int type, boolean retrieveFromCache)
148                    throws com.liferay.portal.kernel.exception.SystemException;
149    
150            /**
151            * Returns all the social equity group settings.
152            *
153            * @return the social equity group settings
154            * @throws SystemException if a system exception occurred
155            */
156            public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll()
157                    throws com.liferay.portal.kernel.exception.SystemException;
158    
159            /**
160            * Returns a range of all the social equity group settings.
161            *
162            * <p>
163            * 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.
164            * </p>
165            *
166            * @param start the lower bound of the range of social equity group settings
167            * @param end the upper bound of the range of social equity group settings (not inclusive)
168            * @return the range of social equity group settings
169            * @throws SystemException if a system exception occurred
170            */
171            public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll(
172                    int start, int end)
173                    throws com.liferay.portal.kernel.exception.SystemException;
174    
175            /**
176            * Returns an ordered range of all the social equity group settings.
177            *
178            * <p>
179            * 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.
180            * </p>
181            *
182            * @param start the lower bound of the range of social equity group settings
183            * @param end the upper bound of the range of social equity group settings (not inclusive)
184            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
185            * @return the ordered range of social equity group settings
186            * @throws SystemException if a system exception occurred
187            */
188            public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll(
189                    int start, int end,
190                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
191                    throws com.liferay.portal.kernel.exception.SystemException;
192    
193            /**
194            * Removes the social equity group setting where groupId = &#63; and classNameId = &#63; and type = &#63; from the database.
195            *
196            * @param groupId the group ID
197            * @param classNameId the class name ID
198            * @param type the type
199            * @throws SystemException if a system exception occurred
200            */
201            public void removeByG_C_T(long groupId, long classNameId, int type)
202                    throws com.liferay.portal.kernel.exception.SystemException,
203                            com.liferay.portlet.social.NoSuchEquityGroupSettingException;
204    
205            /**
206            * Removes all the social equity group settings from the database.
207            *
208            * @throws SystemException if a system exception occurred
209            */
210            public void removeAll()
211                    throws com.liferay.portal.kernel.exception.SystemException;
212    
213            /**
214            * Returns the number of social equity group settings where groupId = &#63; and classNameId = &#63; and type = &#63;.
215            *
216            * @param groupId the group ID
217            * @param classNameId the class name ID
218            * @param type the type
219            * @return the number of matching social equity group settings
220            * @throws SystemException if a system exception occurred
221            */
222            public int countByG_C_T(long groupId, long classNameId, int type)
223                    throws com.liferay.portal.kernel.exception.SystemException;
224    
225            /**
226            * Returns the number of social equity group settings.
227            *
228            * @return the number of social equity group settings
229            * @throws SystemException if a system exception occurred
230            */
231            public int countAll()
232                    throws com.liferay.portal.kernel.exception.SystemException;
233    
234            public SocialEquityGroupSetting remove(
235                    SocialEquityGroupSetting socialEquityGroupSetting)
236                    throws SystemException;
237    }