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