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 SocialActivitySet. 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 SocialActivitySetLocalServiceUtil
036     * @see com.liferay.portlet.social.service.base.SocialActivitySetLocalServiceBaseImpl
037     * @see com.liferay.portlet.social.service.impl.SocialActivitySetLocalServiceImpl
038     * @generated
039     */
040    @ProviderType
041    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
042            PortalException.class, SystemException.class})
043    public interface SocialActivitySetLocalService extends BaseLocalService,
044            PersistedModelLocalService {
045            /*
046             * NOTE FOR DEVELOPERS:
047             *
048             * Never modify or reference this interface directly. Always use {@link SocialActivitySetLocalServiceUtil} to access the social activity set local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivitySetLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
049             */
050            public com.liferay.portlet.social.model.SocialActivitySet addActivitySet(
051                    long activityId)
052                    throws com.liferay.portal.kernel.exception.PortalException;
053    
054            /**
055            * Adds the social activity set to the database. Also notifies the appropriate model listeners.
056            *
057            * @param socialActivitySet the social activity set
058            * @return the social activity set that was added
059            */
060            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
061            public com.liferay.portlet.social.model.SocialActivitySet addSocialActivitySet(
062                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet);
063    
064            /**
065            * Creates a new social activity set with the primary key. Does not add the social activity set to the database.
066            *
067            * @param activitySetId the primary key for the new social activity set
068            * @return the new social activity set
069            */
070            public com.liferay.portlet.social.model.SocialActivitySet createSocialActivitySet(
071                    long activitySetId);
072    
073            public void decrementActivityCount(long activitySetId)
074                    throws com.liferay.portal.kernel.exception.PortalException;
075    
076            public void decrementActivityCount(long classNameId, long classPK)
077                    throws com.liferay.portal.kernel.exception.PortalException;
078    
079            /**
080            * @throws PortalException
081            */
082            @Override
083            public com.liferay.portal.model.PersistedModel deletePersistedModel(
084                    com.liferay.portal.model.PersistedModel persistedModel)
085                    throws com.liferay.portal.kernel.exception.PortalException;
086    
087            /**
088            * Deletes the social activity set with the primary key from the database. Also notifies the appropriate model listeners.
089            *
090            * @param activitySetId the primary key of the social activity set
091            * @return the social activity set that was removed
092            * @throws PortalException if a social activity set with the primary key could not be found
093            */
094            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
095            public com.liferay.portlet.social.model.SocialActivitySet deleteSocialActivitySet(
096                    long activitySetId)
097                    throws com.liferay.portal.kernel.exception.PortalException;
098    
099            /**
100            * Deletes the social activity set from the database. Also notifies the appropriate model listeners.
101            *
102            * @param socialActivitySet the social activity set
103            * @return the social activity set that was removed
104            */
105            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
106            public com.liferay.portlet.social.model.SocialActivitySet deleteSocialActivitySet(
107                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet);
108    
109            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
110    
111            /**
112            * Performs a dynamic query on the database and returns the matching rows.
113            *
114            * @param dynamicQuery the dynamic query
115            * @return the matching rows
116            */
117            public <T> java.util.List<T> dynamicQuery(
118                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
119    
120            /**
121            * Performs a dynamic query on the database and returns a range of the matching rows.
122            *
123            * <p>
124            * 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.SocialActivitySetModelImpl}. 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.
125            * </p>
126            *
127            * @param dynamicQuery the dynamic query
128            * @param start the lower bound of the range of model instances
129            * @param end the upper bound of the range of model instances (not inclusive)
130            * @return the range of matching rows
131            */
132            public <T> java.util.List<T> dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end);
135    
136            /**
137            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
138            *
139            * <p>
140            * 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.SocialActivitySetModelImpl}. 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.
141            * </p>
142            *
143            * @param dynamicQuery the dynamic query
144            * @param start the lower bound of the range of model instances
145            * @param end the upper bound of the range of model instances (not inclusive)
146            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
147            * @return the ordered range of matching rows
148            */
149            public <T> java.util.List<T> dynamicQuery(
150                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
151                    int end,
152                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
153    
154            /**
155            * Returns the number of rows matching the dynamic query.
156            *
157            * @param dynamicQuery the dynamic query
158            * @return the number of rows matching the dynamic query
159            */
160            public long dynamicQueryCount(
161                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
162    
163            /**
164            * Returns the number of rows matching the dynamic query.
165            *
166            * @param dynamicQuery the dynamic query
167            * @param projection the projection to apply to the query
168            * @return the number of rows matching the dynamic query
169            */
170            public long dynamicQueryCount(
171                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
172                    com.liferay.portal.kernel.dao.orm.Projection projection);
173    
174            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
175            public com.liferay.portlet.social.model.SocialActivitySet fetchSocialActivitySet(
176                    long activitySetId);
177    
178            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
179            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
180    
181            /**
182            * Returns the Spring bean ID for this bean.
183            *
184            * @return the Spring bean ID for this bean
185            */
186            public java.lang.String getBeanIdentifier();
187    
188            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
189            public com.liferay.portlet.social.model.SocialActivitySet getClassActivitySet(
190                    long classNameId, long classPK, int type);
191    
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public com.liferay.portlet.social.model.SocialActivitySet getClassActivitySet(
194                    long userId, long classNameId, long classPK, int type);
195    
196            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
197            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getGroupActivitySets(
198                    long groupId, int start, int end);
199    
200            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
201            public int getGroupActivitySetsCount(long groupId);
202    
203            @Override
204            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
205            public com.liferay.portal.model.PersistedModel getPersistedModel(
206                    java.io.Serializable primaryKeyObj)
207                    throws com.liferay.portal.kernel.exception.PortalException;
208    
209            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
210            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getRelationActivitySets(
211                    long userId, int start, int end);
212    
213            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
214            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getRelationActivitySets(
215                    long userId, int type, int start, int end);
216    
217            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
218            public int getRelationActivitySetsCount(long userId);
219    
220            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
221            public int getRelationActivitySetsCount(long userId, int type);
222    
223            /**
224            * Returns the social activity set with the primary key.
225            *
226            * @param activitySetId the primary key of the social activity set
227            * @return the social activity set
228            * @throws PortalException if a social activity set with the primary key could not be found
229            */
230            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
231            public com.liferay.portlet.social.model.SocialActivitySet getSocialActivitySet(
232                    long activitySetId)
233                    throws com.liferay.portal.kernel.exception.PortalException;
234    
235            /**
236            * Returns a range of all the social activity sets.
237            *
238            * <p>
239            * 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.SocialActivitySetModelImpl}. 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.
240            * </p>
241            *
242            * @param start the lower bound of the range of social activity sets
243            * @param end the upper bound of the range of social activity sets (not inclusive)
244            * @return the range of social activity sets
245            */
246            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
247            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getSocialActivitySets(
248                    int start, int end);
249    
250            /**
251            * Returns the number of social activity sets.
252            *
253            * @return the number of social activity sets
254            */
255            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
256            public int getSocialActivitySetsCount();
257    
258            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
259            public com.liferay.portlet.social.model.SocialActivitySet getUserActivitySet(
260                    long groupId, long userId, long classNameId, int type);
261    
262            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
263            public com.liferay.portlet.social.model.SocialActivitySet getUserActivitySet(
264                    long groupId, long userId, int type);
265    
266            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
267            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getUserActivitySets(
268                    long userId, int start, int end);
269    
270            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
271            public int getUserActivitySetsCount(long userId);
272    
273            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
274            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getUserGroupsActivitySets(
275                    long userId, int start, int end);
276    
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public int getUserGroupsActivitySetsCount(long userId);
279    
280            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
281            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getUserViewableActivitySets(
282                    long userId, int start, int end);
283    
284            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
285            public int getUserViewableActivitySetsCount(long userId);
286    
287            public void incrementActivityCount(long activitySetId, long activityId)
288                    throws com.liferay.portal.kernel.exception.PortalException;
289    
290            /**
291            * Sets the Spring bean ID for this bean.
292            *
293            * @param beanIdentifier the Spring bean ID for this bean
294            */
295            public void setBeanIdentifier(java.lang.String beanIdentifier);
296    
297            /**
298            * Updates the social activity set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
299            *
300            * @param socialActivitySet the social activity set
301            * @return the social activity set that was updated
302            */
303            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
304            public com.liferay.portlet.social.model.SocialActivitySet updateSocialActivitySet(
305                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet);
306    }