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;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.kernel.transaction.Isolation;
020    import com.liferay.portal.kernel.transaction.Propagation;
021    import com.liferay.portal.kernel.transaction.Transactional;
022    import com.liferay.portal.service.PersistedModelLocalService;
023    
024    /**
025     * The interface for the social activity local service.
026     *
027     * <p>
028     * This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
029     * </p>
030     *
031     * @author Brian Wing Shun Chan
032     * @see SocialActivityLocalServiceUtil
033     * @see com.liferay.portlet.social.service.base.SocialActivityLocalServiceBaseImpl
034     * @see com.liferay.portlet.social.service.impl.SocialActivityLocalServiceImpl
035     * @generated
036     */
037    @Transactional(isolation = Isolation.PORTAL, rollbackFor =  {
038            PortalException.class, SystemException.class})
039    public interface SocialActivityLocalService extends PersistedModelLocalService {
040            /*
041             * NOTE FOR DEVELOPERS:
042             *
043             * Never modify or reference this interface directly. Always use {@link SocialActivityLocalServiceUtil} to access the social activity local service. Add custom service methods to {@link com.liferay.portlet.social.service.impl.SocialActivityLocalServiceImpl} and rerun ServiceBuilder to automatically copy the method declarations to this interface.
044             */
045    
046            /**
047            * Adds the social activity to the database. Also notifies the appropriate model listeners.
048            *
049            * @param socialActivity the social activity
050            * @return the social activity that was added
051            * @throws SystemException if a system exception occurred
052            */
053            public com.liferay.portlet.social.model.SocialActivity addSocialActivity(
054                    com.liferay.portlet.social.model.SocialActivity socialActivity)
055                    throws com.liferay.portal.kernel.exception.SystemException;
056    
057            /**
058            * Creates a new social activity with the primary key. Does not add the social activity to the database.
059            *
060            * @param activityId the primary key for the new social activity
061            * @return the new social activity
062            */
063            public com.liferay.portlet.social.model.SocialActivity createSocialActivity(
064                    long activityId);
065    
066            /**
067            * Deletes the social activity with the primary key from the database. Also notifies the appropriate model listeners.
068            *
069            * @param activityId the primary key of the social activity
070            * @throws PortalException if a social activity with the primary key could not be found
071            * @throws SystemException if a system exception occurred
072            */
073            public void deleteSocialActivity(long activityId)
074                    throws com.liferay.portal.kernel.exception.PortalException,
075                            com.liferay.portal.kernel.exception.SystemException;
076    
077            /**
078            * Deletes the social activity from the database. Also notifies the appropriate model listeners.
079            *
080            * @param socialActivity the social activity
081            * @throws SystemException if a system exception occurred
082            */
083            public void deleteSocialActivity(
084                    com.liferay.portlet.social.model.SocialActivity socialActivity)
085                    throws com.liferay.portal.kernel.exception.SystemException;
086    
087            /**
088            * Performs a dynamic query on the database and returns the matching rows.
089            *
090            * @param dynamicQuery the dynamic query
091            * @return the matching rows
092            * @throws SystemException if a system exception occurred
093            */
094            @SuppressWarnings("rawtypes")
095            public java.util.List dynamicQuery(
096                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
097                    throws com.liferay.portal.kernel.exception.SystemException;
098    
099            /**
100            * Performs a dynamic query on the database and returns a range of the matching rows.
101            *
102            * <p>
103            * 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.
104            * </p>
105            *
106            * @param dynamicQuery the dynamic query
107            * @param start the lower bound of the range of model instances
108            * @param end the upper bound of the range of model instances (not inclusive)
109            * @return the range of matching rows
110            * @throws SystemException if a system exception occurred
111            */
112            @SuppressWarnings("rawtypes")
113            public java.util.List dynamicQuery(
114                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
115                    int end) throws com.liferay.portal.kernel.exception.SystemException;
116    
117            /**
118            * Performs a dynamic query on the database and returns an ordered range of the matching rows.
119            *
120            * <p>
121            * 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.
122            * </p>
123            *
124            * @param dynamicQuery the dynamic query
125            * @param start the lower bound of the range of model instances
126            * @param end the upper bound of the range of model instances (not inclusive)
127            * @param orderByComparator the comparator to order the results by (optionally <code>null</code>)
128            * @return the ordered range of matching rows
129            * @throws SystemException if a system exception occurred
130            */
131            @SuppressWarnings("rawtypes")
132            public java.util.List dynamicQuery(
133                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
134                    int end,
135                    com.liferay.portal.kernel.util.OrderByComparator orderByComparator)
136                    throws com.liferay.portal.kernel.exception.SystemException;
137    
138            /**
139            * Returns the number of rows that match the dynamic query.
140            *
141            * @param dynamicQuery the dynamic query
142            * @return the number of rows that match the dynamic query
143            * @throws SystemException if a system exception occurred
144            */
145            public long dynamicQueryCount(
146                    com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
147                    throws com.liferay.portal.kernel.exception.SystemException;
148    
149            /**
150            * Returns the social activity with the primary key.
151            *
152            * @param activityId the primary key of the social activity
153            * @return the social activity
154            * @throws PortalException if a social activity with the primary key could not be found
155            * @throws SystemException if a system exception occurred
156            */
157            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
158            public com.liferay.portlet.social.model.SocialActivity getSocialActivity(
159                    long activityId)
160                    throws com.liferay.portal.kernel.exception.PortalException,
161                            com.liferay.portal.kernel.exception.SystemException;
162    
163            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
164            public com.liferay.portal.model.PersistedModel getPersistedModel(
165                    java.io.Serializable primaryKeyObj)
166                    throws com.liferay.portal.kernel.exception.PortalException,
167                            com.liferay.portal.kernel.exception.SystemException;
168    
169            /**
170            * Returns a range of all the social activities.
171            *
172            * <p>
173            * 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.
174            * </p>
175            *
176            * @param start the lower bound of the range of social activities
177            * @param end the upper bound of the range of social activities (not inclusive)
178            * @return the range of social activities
179            * @throws SystemException if a system exception occurred
180            */
181            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
182            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getSocialActivities(
183                    int start, int end)
184                    throws com.liferay.portal.kernel.exception.SystemException;
185    
186            /**
187            * Returns the number of social activities.
188            *
189            * @return the number of social activities
190            * @throws SystemException if a system exception occurred
191            */
192            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
193            public int getSocialActivitiesCount()
194                    throws com.liferay.portal.kernel.exception.SystemException;
195    
196            /**
197            * Updates the social activity in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
198            *
199            * @param socialActivity the social activity
200            * @return the social activity that was updated
201            * @throws SystemException if a system exception occurred
202            */
203            public com.liferay.portlet.social.model.SocialActivity updateSocialActivity(
204                    com.liferay.portlet.social.model.SocialActivity socialActivity)
205                    throws com.liferay.portal.kernel.exception.SystemException;
206    
207            /**
208            * Updates the social activity in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
209            *
210            * @param socialActivity the social activity
211            * @param merge whether to merge the social activity with the current session. See {@link com.liferay.portal.service.persistence.BatchSession#update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean)} for an explanation.
212            * @return the social activity that was updated
213            * @throws SystemException if a system exception occurred
214            */
215            public com.liferay.portlet.social.model.SocialActivity updateSocialActivity(
216                    com.liferay.portlet.social.model.SocialActivity socialActivity,
217                    boolean merge)
218                    throws com.liferay.portal.kernel.exception.SystemException;
219    
220            /**
221            * Returns the Spring bean ID for this bean.
222            *
223            * @return the Spring bean ID for this bean
224            */
225            public java.lang.String getBeanIdentifier();
226    
227            /**
228            * Sets the Spring bean ID for this bean.
229            *
230            * @param beanIdentifier the Spring bean ID for this bean
231            */
232            public void setBeanIdentifier(java.lang.String beanIdentifier);
233    
234            public com.liferay.portlet.social.model.SocialActivity addActivity(
235                    long userId, long groupId, java.util.Date createDate,
236                    java.lang.String className, long classPK, int type,
237                    java.lang.String extraData, long receiverUserId)
238                    throws com.liferay.portal.kernel.exception.PortalException,
239                            com.liferay.portal.kernel.exception.SystemException;
240    
241            public com.liferay.portlet.social.model.SocialActivity addActivity(
242                    long userId, long groupId, java.lang.String className, long classPK,
243                    int type, java.lang.String extraData, long receiverUserId)
244                    throws com.liferay.portal.kernel.exception.PortalException,
245                            com.liferay.portal.kernel.exception.SystemException;
246    
247            public com.liferay.portlet.social.model.SocialActivity addUniqueActivity(
248                    long userId, long groupId, java.util.Date createDate,
249                    java.lang.String className, long classPK, int type,
250                    java.lang.String extraData, long receiverUserId)
251                    throws com.liferay.portal.kernel.exception.PortalException,
252                            com.liferay.portal.kernel.exception.SystemException;
253    
254            public com.liferay.portlet.social.model.SocialActivity addUniqueActivity(
255                    long userId, long groupId, java.lang.String className, long classPK,
256                    int type, java.lang.String extraData, long receiverUserId)
257                    throws com.liferay.portal.kernel.exception.PortalException,
258                            com.liferay.portal.kernel.exception.SystemException;
259    
260            public void deleteActivities(long classNameId, long classPK)
261                    throws com.liferay.portal.kernel.exception.SystemException;
262    
263            public void deleteActivities(java.lang.String className, long classPK)
264                    throws com.liferay.portal.kernel.exception.SystemException;
265    
266            public void deleteActivity(long activityId)
267                    throws com.liferay.portal.kernel.exception.PortalException,
268                            com.liferay.portal.kernel.exception.SystemException;
269    
270            public void deleteActivity(
271                    com.liferay.portlet.social.model.SocialActivity activity)
272                    throws com.liferay.portal.kernel.exception.SystemException;
273    
274            public void deleteUserActivities(long userId)
275                    throws com.liferay.portal.kernel.exception.SystemException;
276    
277            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
278            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getActivities(
279                    long classNameId, int start, int end)
280                    throws com.liferay.portal.kernel.exception.SystemException;
281    
282            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
283            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getActivities(
284                    long mirrorActivityId, long classNameId, long classPK, int start,
285                    int end) throws com.liferay.portal.kernel.exception.SystemException;
286    
287            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
288            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getActivities(
289                    long mirrorActivityId, java.lang.String className, long classPK,
290                    int start, int end)
291                    throws com.liferay.portal.kernel.exception.SystemException;
292    
293            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
294            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getActivities(
295                    java.lang.String className, int start, int end)
296                    throws com.liferay.portal.kernel.exception.SystemException;
297    
298            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
299            public int getActivitiesCount(long classNameId)
300                    throws com.liferay.portal.kernel.exception.SystemException;
301    
302            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
303            public int getActivitiesCount(long mirrorActivityId, long classNameId,
304                    long classPK)
305                    throws com.liferay.portal.kernel.exception.SystemException;
306    
307            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
308            public int getActivitiesCount(long mirrorActivityId,
309                    java.lang.String className, long classPK)
310                    throws com.liferay.portal.kernel.exception.SystemException;
311    
312            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
313            public int getActivitiesCount(java.lang.String className)
314                    throws com.liferay.portal.kernel.exception.SystemException;
315    
316            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
317            public com.liferay.portlet.social.model.SocialActivity getActivity(
318                    long activityId)
319                    throws com.liferay.portal.kernel.exception.PortalException,
320                            com.liferay.portal.kernel.exception.SystemException;
321    
322            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
323            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getGroupActivities(
324                    long groupId, int start, int end)
325                    throws com.liferay.portal.kernel.exception.SystemException;
326    
327            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
328            public int getGroupActivitiesCount(long groupId)
329                    throws com.liferay.portal.kernel.exception.SystemException;
330    
331            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
332            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getGroupUsersActivities(
333                    long groupId, int start, int end)
334                    throws com.liferay.portal.kernel.exception.SystemException;
335    
336            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
337            public int getGroupUsersActivitiesCount(long groupId)
338                    throws com.liferay.portal.kernel.exception.SystemException;
339    
340            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
341            public com.liferay.portlet.social.model.SocialActivity getMirrorActivity(
342                    long mirrorActivityId)
343                    throws com.liferay.portal.kernel.exception.PortalException,
344                            com.liferay.portal.kernel.exception.SystemException;
345    
346            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
347            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getOrganizationActivities(
348                    long organizationId, int start, int end)
349                    throws com.liferay.portal.kernel.exception.SystemException;
350    
351            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
352            public int getOrganizationActivitiesCount(long organizationId)
353                    throws com.liferay.portal.kernel.exception.SystemException;
354    
355            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
356            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getOrganizationUsersActivities(
357                    long organizationId, int start, int end)
358                    throws com.liferay.portal.kernel.exception.SystemException;
359    
360            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
361            public int getOrganizationUsersActivitiesCount(long organizationId)
362                    throws com.liferay.portal.kernel.exception.SystemException;
363    
364            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
365            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getRelationActivities(
366                    long userId, int start, int end)
367                    throws com.liferay.portal.kernel.exception.SystemException;
368    
369            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
370            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getRelationActivities(
371                    long userId, int type, int start, int end)
372                    throws com.liferay.portal.kernel.exception.SystemException;
373    
374            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
375            public int getRelationActivitiesCount(long userId)
376                    throws com.liferay.portal.kernel.exception.SystemException;
377    
378            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
379            public int getRelationActivitiesCount(long userId, int type)
380                    throws com.liferay.portal.kernel.exception.SystemException;
381    
382            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
383            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getUserActivities(
384                    long userId, int start, int end)
385                    throws com.liferay.portal.kernel.exception.SystemException;
386    
387            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
388            public int getUserActivitiesCount(long userId)
389                    throws com.liferay.portal.kernel.exception.SystemException;
390    
391            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
392            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getUserGroupsActivities(
393                    long userId, int start, int end)
394                    throws com.liferay.portal.kernel.exception.SystemException;
395    
396            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
397            public int getUserGroupsActivitiesCount(long userId)
398                    throws com.liferay.portal.kernel.exception.SystemException;
399    
400            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
401            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getUserGroupsAndOrganizationsActivities(
402                    long userId, int start, int end)
403                    throws com.liferay.portal.kernel.exception.SystemException;
404    
405            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
406            public int getUserGroupsAndOrganizationsActivitiesCount(long userId)
407                    throws com.liferay.portal.kernel.exception.SystemException;
408    
409            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
410            public java.util.List<com.liferay.portlet.social.model.SocialActivity> getUserOrganizationsActivities(
411                    long userId, int start, int end)
412                    throws com.liferay.portal.kernel.exception.SystemException;
413    
414            @Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
415            public int getUserOrganizationsActivitiesCount(long userId)
416                    throws com.liferay.portal.kernel.exception.SystemException;
417    }