001    /**
002     * Copyright (c) 2000-present 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;
016    
017    import aQute.bnd.annotation.ProviderType;
018    
019    import com.liferay.portal.kernel.exception.PortalException;
020    import com.liferay.portal.kernel.exception.SystemException;
021    import com.liferay.portal.kernel.search.IndexableType;
022    import com.liferay.portal.kernel.transaction.Isolation;
023    import com.liferay.portal.kernel.transaction.Propagation;
024    import com.liferay.portal.kernel.transaction.Transactional;
025    import com.liferay.portal.service.BaseLocalService;
026    import com.liferay.portal.service.PersistedModelLocalService;
027    
028    /**
029     * Provides the local service interface for SocialActivityLimit. Methods of this
030     * service will not have security checks based on the propagated JAAS
031     * credentials because this service can only be accessed from within the same
032     * VM.
033     *
034     * @author Brian Wing Shun Chan
035     * @see SocialActivityLimitLocalServiceUtil
036     * @see com.liferay.portlet.social.service.base.SocialActivityLimitLocalServiceBaseImpl
037     * @see com.liferay.portlet.social.service.impl.SocialActivityLimitLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface SocialActivityLimitLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link SocialActivityLimitLocalServiceUtil} to access the social activity limit local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivityLimitLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050            @com.liferay.portal.kernel.transaction.Transactional(propagation = Propagation.REQUIRES_NEW)
051            public com.liferay.portlet.social.model.SocialActivityLimit addActivityLimit(
052                    long userId, long groupId, long classNameId, long classPK,
053                    int activityType, java.lang.String activityCounterName, int limitPeriod)
054                    throws com.liferay.portal.kernel.exception.PortalException;
055    
056            /**
057            * Adds the social activity limit to the database. Also notifies the appropriate model listeners.
058            *
059            * @param socialActivityLimit the social activity limit
060            * @return the social activity limit that was added
061            */
062            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
063            public com.liferay.portlet.social.model.SocialActivityLimit addSocialActivityLimit(
064                    com.liferay.portlet.social.model.SocialActivityLimit socialActivityLimit);
065    
066            /**
067            * Creates a new social activity limit with the primary key. Does not add the social activity limit to the database.
068            *
069            * @param activityLimitId the primary key for the new social activity limit
070            * @return the new social activity limit
071            */
072            public com.liferay.portlet.social.model.SocialActivityLimit createSocialActivityLimit(
073                    long activityLimitId);
074    
075            /**
076            * @throws PortalException
077            */
078            @Override
079            public com.liferay.portal.model.PersistedModel deletePersistedModel(
080                    com.liferay.portal.model.PersistedModel persistedModel)
081                    throws com.liferay.portal.kernel.exception.PortalException;
082    
083            /**
084            * Deletes the social activity limit with the primary key from the database. Also notifies the appropriate model listeners.
085            *
086            * @param activityLimitId the primary key of the social activity limit
087            * @return the social activity limit that was removed
088            * @throws PortalException if a social activity limit with the primary key could not be found
089            */
090            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
091            public com.liferay.portlet.social.model.SocialActivityLimit deleteSocialActivityLimit(
092                    long activityLimitId)
093                    throws com.liferay.portal.kernel.exception.PortalException;
094    
095            /**
096            * Deletes the social activity limit from the database. Also notifies the appropriate model listeners.
097            *
098            * @param socialActivityLimit the social activity limit
099            * @return the social activity limit that was removed
100            */
101            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
102            public com.liferay.portlet.social.model.SocialActivityLimit deleteSocialActivityLimit(
103                    com.liferay.portlet.social.model.SocialActivityLimit socialActivityLimit);
104    
105            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
106    
107            /**
108            * Performs a dynamic query on the database and returns the matching rows.
109            *
110            * @param dynamicQuery the dynamic query
111            * @return the matching rows
112            */
113            public <T> java.util.List<T> dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
115    
116            /**
117            * Performs a dynamic query on the database and returns a range of the matching rows.
118            *
119            * <p>
120            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivityLimitModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
121            * </p>
122            *
123            * @param dynamicQuery the dynamic query
124            * @param start the lower bound of the range of model instances
125            * @param end the upper bound of the range of model instances (not inclusive)
126            * @return the range of matching rows
127            */
128            public <T> java.util.List<T> dynamicQuery(
129                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
130                    int end);
131    
132            /**
133            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
134            *
135            * <p>
136            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivityLimitModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
137            * </p>
138            *
139            * @param dynamicQuery the dynamic query
140            * @param start the lower bound of the range of model instances
141            * @param end the upper bound of the range of model instances (not inclusive)
142            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
143            * @return the ordered range of matching rows
144            */
145            public <T> java.util.List<T> dynamicQuery(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
147                    int end,
148                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
149    
150            /**
151            * Returns the number of rows matching the dynamic query.
152            *
153            * @param dynamicQuery the dynamic query
154            * @return the number of rows matching the dynamic query
155            */
156            public long dynamicQueryCount(
157                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
158    
159            /**
160            * Returns the number of rows matching the dynamic query.
161            *
162            * @param dynamicQuery the dynamic query
163            * @param projection the projection to apply to the query
164            * @return the number of rows matching the dynamic query
165            */
166            public long dynamicQueryCount(
167                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
168                    com.liferay.portal.kernel.dao.orm.Projection projection);
169    
170            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
171            public com.liferay.portlet.social.model.SocialActivityLimit fetchActivityLimit(
172                    long groupId, long userId, long classNameId, long classPK,
173                    int activityType, java.lang.String activityCounterName);
174    
175            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
176            public com.liferay.portlet.social.model.SocialActivityLimit fetchSocialActivityLimit(
177                    long activityLimitId);
178    
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
181    
182            /**
183            * Returns the Spring bean ID for this bean.
184            *
185            * @return the Spring bean ID for this bean
186            */
187            public java.lang.String getBeanIdentifier();
188    
189            @Override
190            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
191            public com.liferay.portal.model.PersistedModel getPersistedModel(
192                    java.io.Serializable primaryKeyObj)
193                    throws com.liferay.portal.kernel.exception.PortalException;
194    
195            /**
196            * Returns the social activity limit with the primary key.
197            *
198            * @param activityLimitId the primary key of the social activity limit
199            * @return the social activity limit
200            * @throws PortalException if a social activity limit with the primary key could not be found
201            */
202            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
203            public com.liferay.portlet.social.model.SocialActivityLimit getSocialActivityLimit(
204                    long activityLimitId)
205                    throws com.liferay.portal.kernel.exception.PortalException;
206    
207            /**
208            * Returns a range of all the social activity limits.
209            *
210            * <p>
211            * 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. If <code>orderByComparator</code> is specified, then the query will include the given ORDER BY logic. If <code>orderByComparator</code> is absent and pagination is required (<code>start</code> and <code>end</code> are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.social.model.impl.SocialActivityLimitModelImpl}. If both <code>orderByComparator</code> and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
212            * </p>
213            *
214            * @param start the lower bound of the range of social activity limits
215            * @param end the upper bound of the range of social activity limits (not inclusive)
216            * @return the range of social activity limits
217            */
218            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
219            public java.util.List<com.liferay.portlet.social.model.SocialActivityLimit> getSocialActivityLimits(
220                    int start, int end);
221    
222            /**
223            * Returns the number of social activity limits.
224            *
225            * @return the number of social activity limits
226            */
227            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
228            public int getSocialActivityLimitsCount();
229    
230            /**
231            * Sets the Spring bean ID for this bean.
232            *
233            * @param beanIdentifier the Spring bean ID for this bean
234            */
235            public void setBeanIdentifier(java.lang.String beanIdentifier);
236    
237            /**
238            * Updates the social activity limit in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
239            *
240            * @param socialActivityLimit the social activity limit
241            * @return the social activity limit that was updated
242            */
243            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
244            public com.liferay.portlet.social.model.SocialActivityLimit updateSocialActivityLimit(
245                    com.liferay.portlet.social.model.SocialActivityLimit socialActivityLimit);
246    }