001    /**
002     * Copyright (c) 2000-2011 Liferay, Inc. All rights reserved.
003     *
004     * The contents of this file are subject to the terms of the Liferay Enterprise
005     * Subscription License ("License"). You may not use this file except in
006     * compliance with the License. You can obtain a copy of the License by
007     * contacting Liferay, Inc. See the License for the specific language governing
008     * permissions and limitations under the License, including but not limited to
009     * distribution rights of the Software.
010     *
011     *
012     *
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 to cache
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 to cache
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 to remove
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            * Finds 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 to find
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            * Finds 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 to find
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            * Finds 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 to search with
112            * @param classNameId the class name ID to search with
113            * @param type the type to search with
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            * Finds 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 to search with
127            * @param classNameId the class name ID to search with
128            * @param type the type to search with
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            * Finds 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 to search with
140            * @param classNameId the class name ID to search with
141            * @param type the type to search with
142            * @return the matching social equity group setting, or <code>null</code> if a matching social equity group setting could not be found
143            * @throws SystemException if a system exception occurred
144            */
145            public com.liferay.portlet.social.model.SocialEquityGroupSetting fetchByG_C_T(
146                    long groupId, long classNameId, int type, boolean retrieveFromCache)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Finds all the social equity group settings.
151            *
152            * @return the social equity group settings
153            * @throws SystemException if a system exception occurred
154            */
155            public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll()
156                    throws com.liferay.portal.kernel.exception.SystemException;
157    
158            /**
159            * Finds a range of all the social equity group settings.
160            *
161            * <p>
162            * 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.
163            * </p>
164            *
165            * @param start the lower bound of the range of social equity group settings to return
166            * @param end the upper bound of the range of social equity group settings to return (not inclusive)
167            * @return the range of social equity group settings
168            * @throws SystemException if a system exception occurred
169            */
170            public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll(
171                    int start, int end)
172                    throws com.liferay.portal.kernel.exception.SystemException;
173    
174            /**
175            * Finds an ordered range of all the social equity group settings.
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 start the lower bound of the range of social equity group settings to return
182            * @param end the upper bound of the range of social equity group settings to return (not inclusive)
183            * @param orderByComparator the comparator to order the results by
184            * @return the ordered range of social equity group settings
185            * @throws SystemException if a system exception occurred
186            */
187            public java.util.List<com.liferay.portlet.social.model.SocialEquityGroupSetting> findAll(
188                    int start, int end,
189                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
190                    throws com.liferay.portal.kernel.exception.SystemException;
191    
192            /**
193            * Removes the social equity group setting where groupId = &#63; and classNameId = &#63; and type = &#63; from the database.
194            *
195            * @param groupId the group ID to search with
196            * @param classNameId the class name ID to search with
197            * @param type the type to search with
198            * @throws SystemException if a system exception occurred
199            */
200            public void removeByG_C_T(long groupId, long classNameId, int type)
201                    throws com.liferay.portal.kernel.exception.SystemException,
202                            com.liferay.portlet.social.NoSuchEquityGroupSettingException;
203    
204            /**
205            * Removes all the social equity group settings from the database.
206            *
207            * @throws SystemException if a system exception occurred
208            */
209            public void removeAll()
210                    throws com.liferay.portal.kernel.exception.SystemException;
211    
212            /**
213            * Counts all the social equity group settings where groupId = &#63; and classNameId = &#63; and type = &#63;.
214            *
215            * @param groupId the group ID to search with
216            * @param classNameId the class name ID to search with
217            * @param type the type to search with
218            * @return the number of matching social equity group settings
219            * @throws SystemException if a system exception occurred
220            */
221            public int countByG_C_T(long groupId, long classNameId, int type)
222                    throws com.liferay.portal.kernel.exception.SystemException;
223    
224            /**
225            * Counts all the social equity group settings.
226            *
227            * @return the number of social equity group settings
228            * @throws SystemException if a system exception occurred
229            */
230            public int countAll()
231                    throws com.liferay.portal.kernel.exception.SystemException;
232    
233            public SocialEquityGroupSetting remove(
234                    SocialEquityGroupSetting socialEquityGroupSetting)
235                    throws SystemException;
236    }