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) throws PortalException;
052    
053            /**
054            * Adds the social activity set to the database. Also notifies the appropriate model listeners.
055            *
056            * @param socialActivitySet the social activity set
057            * @return the social activity set that was added
058            */
059            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
060            public com.liferay.portlet.social.model.SocialActivitySet addSocialActivitySet(
061                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet);
062    
063            /**
064            * Creates a new social activity set with the primary key. Does not add the social activity set to the database.
065            *
066            * @param activitySetId the primary key for the new social activity set
067            * @return the new social activity set
068            */
069            public com.liferay.portlet.social.model.SocialActivitySet createSocialActivitySet(
070                    long activitySetId);
071    
072            public void decrementActivityCount(long activitySetId)
073                    throws PortalException;
074    
075            public void decrementActivityCount(long classNameId, long classPK)
076                    throws PortalException;
077    
078            /**
079            * @throws PortalException
080            */
081            @Override
082            public com.liferay.portal.model.PersistedModel deletePersistedModel(
083                    com.liferay.portal.model.PersistedModel persistedModel)
084                    throws PortalException;
085    
086            /**
087            * Deletes the social activity set with the primary key from the database. Also notifies the appropriate model listeners.
088            *
089            * @param activitySetId the primary key of the social activity set
090            * @return the social activity set that was removed
091            * @throws PortalException if a social activity set with the primary key could not be found
092            */
093            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
094            public com.liferay.portlet.social.model.SocialActivitySet deleteSocialActivitySet(
095                    long activitySetId) throws PortalException;
096    
097            /**
098            * Deletes the social activity set from the database. Also notifies the appropriate model listeners.
099            *
100            * @param socialActivitySet the social activity set
101            * @return the social activity set that was removed
102            */
103            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.DELETE)
104            public com.liferay.portlet.social.model.SocialActivitySet deleteSocialActivitySet(
105                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet);
106    
107            public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery();
108    
109            /**
110            * Performs a dynamic query on the database and returns the matching rows.
111            *
112            * @param dynamicQuery the dynamic query
113            * @return the matching rows
114            */
115            public <T> java.util.List<T> dynamicQuery(
116                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
117    
118            /**
119            * Performs a dynamic query on the database and returns a range of the matching rows.
120            *
121            * <p>
122            * 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.
123            * </p>
124            *
125            * @param dynamicQuery the dynamic query
126            * @param start the lower bound of the range of model instances
127            * @param end the upper bound of the range of model instances (not inclusive)
128            * @return the range of matching rows
129            */
130            public <T> java.util.List<T> dynamicQuery(
131                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
132                    int end);
133    
134            /**
135            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
136            *
137            * <p>
138            * 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.
139            * </p>
140            *
141            * @param dynamicQuery the dynamic query
142            * @param start the lower bound of the range of model instances
143            * @param end the upper bound of the range of model instances (not inclusive)
144            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
145            * @return the ordered range of matching rows
146            */
147            public <T> java.util.List<T> dynamicQuery(
148                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
149                    int end,
150                    com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator);
151    
152            /**
153            * Returns the number of rows matching the dynamic query.
154            *
155            * @param dynamicQuery the dynamic query
156            * @return the number of rows matching the dynamic query
157            */
158            public long dynamicQueryCount(
159                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery);
160    
161            /**
162            * Returns the number of rows matching the dynamic query.
163            *
164            * @param dynamicQuery the dynamic query
165            * @param projection the projection to apply to the query
166            * @return the number of rows matching the dynamic query
167            */
168            public long dynamicQueryCount(
169                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
170                    com.liferay.portal.kernel.dao.orm.Projection projection);
171    
172            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
173            public com.liferay.portlet.social.model.SocialActivitySet fetchSocialActivitySet(
174                    long activitySetId);
175    
176            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
177            public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery();
178    
179            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
180            public com.liferay.portlet.social.model.SocialActivitySet getClassActivitySet(
181                    long classNameId, long classPK, int type);
182    
183            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
184            public com.liferay.portlet.social.model.SocialActivitySet getClassActivitySet(
185                    long userId, long classNameId, long classPK, int type);
186    
187            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
188            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getGroupActivitySets(
189                    long groupId, int start, int end);
190    
191            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
192            public int getGroupActivitySetsCount(long groupId);
193    
194            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
195            public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
196    
197            /**
198            * Returns the OSGi service identifier.
199            *
200            * @return the OSGi service identifier
201            */
202            public java.lang.String getOSGiServiceIdentifier();
203    
204            @Override
205            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
206            public com.liferay.portal.model.PersistedModel getPersistedModel(
207                    java.io.Serializable primaryKeyObj) throws 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) throws PortalException;
233    
234            /**
235            * Returns a range of all the social activity sets.
236            *
237            * <p>
238            * 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.
239            * </p>
240            *
241            * @param start the lower bound of the range of social activity sets
242            * @param end the upper bound of the range of social activity sets (not inclusive)
243            * @return the range of social activity sets
244            */
245            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
246            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getSocialActivitySets(
247                    int start, int end);
248    
249            /**
250            * Returns the number of social activity sets.
251            *
252            * @return the number of social activity sets
253            */
254            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
255            public int getSocialActivitySetsCount();
256    
257            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
258            public com.liferay.portlet.social.model.SocialActivitySet getUserActivitySet(
259                    long groupId, long userId, long classNameId, int type);
260    
261            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
262            public com.liferay.portlet.social.model.SocialActivitySet getUserActivitySet(
263                    long groupId, long userId, int type);
264    
265            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
266            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getUserActivitySets(
267                    long userId, int start, int end);
268    
269            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
270            public int getUserActivitySetsCount(long userId);
271    
272            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
273            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getUserGroupsActivitySets(
274                    long userId, int start, int end);
275    
276            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
277            public int getUserGroupsActivitySetsCount(long userId);
278    
279            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
280            public java.util.List<com.liferay.portlet.social.model.SocialActivitySet> getUserViewableActivitySets(
281                    long userId, int start, int end);
282    
283            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
284            public int getUserViewableActivitySetsCount(long userId);
285    
286            public void incrementActivityCount(long activitySetId, long activityId)
287                    throws PortalException;
288    
289            /**
290            * Updates the social activity set in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
291            *
292            * @param socialActivitySet the social activity set
293            * @return the social activity set that was updated
294            */
295            @com.liferay.portal.kernel.search.Indexable(type = IndexableType.REINDEX)
296            public com.liferay.portlet.social.model.SocialActivitySet updateSocialActivitySet(
297                    com.liferay.portlet.social.model.SocialActivitySet socialActivitySet);
298    }