com.liferay.portlet.social.service.http

Class SocialActivityServiceSoap

java.lang.Object

com.liferay.portlet.social.service.http.SocialActivityServiceSoap

public class SocialActivityServiceSoap
extends java.lang.Object

Provides the SOAP utility for the SocialActivityServiceUtil service utility. The static methods of this class call the same methods of the service utility. However, the signatures are different because it is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a java.util.List, that is translated to an array of com.liferay.social.kernel.model.SocialActivitySoap. If the method in the service utility returns a com.liferay.social.kernel.model.SocialActivity, that is translated to a com.liferay.social.kernel.model.SocialActivitySoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

SocialActivityServiceHttp

Generated:

Constructor Summary

Constructors

Constructor and Description
SocialActivityServiceSoap()

Method Summary

Modifier and Type	Method and Description
static com.liferay.social.kernel.model.SocialActivitySoap[]	getActivities(long classNameId, int start, int end) Returns a range of all the activities done on assets identified by the class name ID.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getActivities(long mirrorActivityId, long classNameId, long classPK, int start, int end) Returns a range of all the activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getActivities(long mirrorActivityId, java.lang.String className, long classPK, int start, int end) Returns a range of all the activities done on the asset identified by the class name and the class primary key that are mirrors of the activity identified by the mirror activity ID.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getActivities(java.lang.String className, int start, int end) Returns a range of all the activities done on assets identified by the class name.
static int	getActivitiesCount(long classNameId) Returns the number of activities done on assets identified by the class name ID.
static int	getActivitiesCount(long mirrorActivityId, long classNameId, long classPK) Returns the number of activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.
static int	getActivitiesCount(long mirrorActivityId, java.lang.String className, long classPK) Returns the number of activities done on the asset identified by the class name and class primary key that are mirrors of the activity identified by the mirror activity ID.
static int	getActivitiesCount(java.lang.String className) Returns the number of activities done on assets identified by class name.
static com.liferay.social.kernel.model.SocialActivitySoap	getActivity(long activityId) Returns the activity identified by its primary key.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getActivitySetActivities(long activitySetId, int start, int end)
static com.liferay.social.kernel.model.SocialActivitySoap[]	getGroupActivities(long groupId, int start, int end) Returns a range of all the activities done in the group.
static int	getGroupActivitiesCount(long groupId) Returns the number of activities done in the group.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getGroupUsersActivities(long groupId, int start, int end) Returns a range of activities done by users that are members of the group.
static int	getGroupUsersActivitiesCount(long groupId) Returns the number of activities done by users that are members of the group.
static com.liferay.social.kernel.model.SocialActivitySoap	getMirrorActivity(long mirrorActivityId) Returns the activity that has the mirror activity.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getOrganizationActivities(long organizationId, int start, int end) Returns a range of all the activities done in the organization.
static int	getOrganizationActivitiesCount(long organizationId) Returns the number of activities done in the organization.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getOrganizationUsersActivities(long organizationId, int start, int end) Returns a range of all the activities done by users of the organization.
static int	getOrganizationUsersActivitiesCount(long organizationId) Returns the number of activities done by users of the organization.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getRelationActivities(long userId, int start, int end) Returns a range of all the activities done by users in a relationship with the user identified by the user ID.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getRelationActivities(long userId, int type, int start, int end) Returns a range of all the activities done by users in a relationship of type type with the user identified by userId.
static int	getRelationActivitiesCount(long userId) Returns the number of activities done by users in a relationship with the user identified by userId.
static int	getRelationActivitiesCount(long userId, int type) Returns the number of activities done by users in a relationship of type type with the user identified by userId.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getUserActivities(long userId, int start, int end) Returns a range of all the activities done by the user.
static int	getUserActivitiesCount(long userId) Returns the number of activities done by the user.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getUserGroupsActivities(long userId, int start, int end) Returns a range of all the activities done in the user's groups.
static int	getUserGroupsActivitiesCount(long userId) Returns the number of activities done in user's groups.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getUserGroupsAndOrganizationsActivities(long userId, int start, int end) Returns a range of all the activities done in the user's groups and organizations.
static int	getUserGroupsAndOrganizationsActivitiesCount(long userId) Returns the number of activities done in user's groups and organizations.
static com.liferay.social.kernel.model.SocialActivitySoap[]	getUserOrganizationsActivities(long userId, int start, int end) Returns a range of all activities done in the user's organizations.
static int	getUserOrganizationsActivitiesCount(long userId) Returns the number of activities done in the user's organizations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SocialActivityServiceSoap

public SocialActivityServiceSoap()

Method Detail

getActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getActivities(long classNameId,
                                                                                 int start,
                                                                                 int end)
                                                                          throws java.rmi.RemoteException

Returns a range of all the activities done on assets identified by the class name ID.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

classNameId - the target asset's class name ID

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getActivities(long mirrorActivityId,
                                                                                 long classNameId,
                                                                                 long classPK,
                                                                                 int start,
                                                                                 int end)
                                                                          throws java.rmi.RemoteException

Returns a range of all the activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

mirrorActivityId - the primary key of the mirror activity

classNameId - the target asset's class name ID

classPK - the primary key of the target asset

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getActivities(long mirrorActivityId,
                                                                                 java.lang.String className,
                                                                                 long classPK,
                                                                                 int start,
                                                                                 int end)
                                                                          throws java.rmi.RemoteException

Returns a range of all the activities done on the asset identified by the class name and the class primary key that are mirrors of the activity identified by the mirror activity ID.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

mirrorActivityId - the primary key of the mirror activity

className - the target asset's class name

classPK - the primary key of the target asset

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getActivities(java.lang.String className,
                                                                                 int start,
                                                                                 int end)
                                                                          throws java.rmi.RemoteException

Returns a range of all the activities done on assets identified by the class name.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

className - the target asset's class name

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getActivitiesCount

public static int getActivitiesCount(long classNameId)
                              throws java.rmi.RemoteException

Returns the number of activities done on assets identified by the class name ID.

Parameters:

classNameId - the target asset's class name ID

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getActivitiesCount

public static int getActivitiesCount(long mirrorActivityId,
                                     long classNameId,
                                     long classPK)
                              throws java.rmi.RemoteException

Returns the number of activities done on the asset identified by the class name ID and class primary key that are mirrors of the activity identified by the mirror activity ID.

Parameters:

mirrorActivityId - the primary key of the mirror activity

classNameId - the target asset's class name ID

classPK - the primary key of the target asset

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getActivitiesCount

public static int getActivitiesCount(long mirrorActivityId,
                                     java.lang.String className,
                                     long classPK)
                              throws java.rmi.RemoteException

Returns the number of activities done on the asset identified by the class name and class primary key that are mirrors of the activity identified by the mirror activity ID.

Parameters:

mirrorActivityId - the primary key of the mirror activity

className - the target asset's class name

classPK - the primary key of the target asset

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getActivitiesCount

public static int getActivitiesCount(java.lang.String className)
                              throws java.rmi.RemoteException

Returns the number of activities done on assets identified by class name.

Parameters:

className - the target asset's class name

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getActivity

public static com.liferay.social.kernel.model.SocialActivitySoap getActivity(long activityId)
                                                                      throws java.rmi.RemoteException

Returns the activity identified by its primary key.

Parameters:

activityId - the primary key of the activity

Returns:

Returns the activity

Throws:

java.rmi.RemoteException

getActivitySetActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getActivitySetActivities(long activitySetId,
                                                                                            int start,
                                                                                            int end)
                                                                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getGroupActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getGroupActivities(long groupId,
                                                                                      int start,
                                                                                      int end)
                                                                               throws java.rmi.RemoteException

Returns a range of all the activities done in the group.

This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

groupId - the primary key of the group

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getGroupActivitiesCount

public static int getGroupActivitiesCount(long groupId)
                                   throws java.rmi.RemoteException

Returns the number of activities done in the group.

This method only counts activities without mirrors.

Parameters:

groupId - the primary key of the group

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getGroupUsersActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getGroupUsersActivities(long groupId,
                                                                                           int start,
                                                                                           int end)
                                                                                    throws java.rmi.RemoteException

Returns a range of activities done by users that are members of the group.

This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

groupId - the primary key of the group

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getGroupUsersActivitiesCount

public static int getGroupUsersActivitiesCount(long groupId)
                                        throws java.rmi.RemoteException

Returns the number of activities done by users that are members of the group.

This method only counts activities without mirrors.

Parameters:

groupId - the primary key of the group

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getMirrorActivity

public static com.liferay.social.kernel.model.SocialActivitySoap getMirrorActivity(long mirrorActivityId)
                                                                            throws java.rmi.RemoteException

Returns the activity that has the mirror activity.

Parameters:

mirrorActivityId - the primary key of the mirror activity

Returns:

Returns the mirror activity

Throws:

java.rmi.RemoteException

getOrganizationActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getOrganizationActivities(long organizationId,
                                                                                             int start,
                                                                                             int end)
                                                                                      throws java.rmi.RemoteException

Returns a range of all the activities done in the organization. This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

organizationId - the primary key of the organization

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getOrganizationActivitiesCount

public static int getOrganizationActivitiesCount(long organizationId)
                                          throws java.rmi.RemoteException

Returns the number of activities done in the organization. This method only counts activities without mirrors.

Parameters:

organizationId - the primary key of the organization

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getOrganizationUsersActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getOrganizationUsersActivities(long organizationId,
                                                                                                  int start,
                                                                                                  int end)
                                                                                           throws java.rmi.RemoteException

Returns a range of all the activities done by users of the organization. This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

organizationId - the primary key of the organization

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getOrganizationUsersActivitiesCount

public static int getOrganizationUsersActivitiesCount(long organizationId)
                                               throws java.rmi.RemoteException

Returns the number of activities done by users of the organization. This method only counts activities without mirrors.

Parameters:

organizationId - the primary key of the organization

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getRelationActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getRelationActivities(long userId,
                                                                                         int start,
                                                                                         int end)
                                                                                  throws java.rmi.RemoteException

Returns a range of all the activities done by users in a relationship with the user identified by the user ID.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getRelationActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getRelationActivities(long userId,
                                                                                         int type,
                                                                                         int start,
                                                                                         int end)
                                                                                  throws java.rmi.RemoteException

Returns a range of all the activities done by users in a relationship of type type with the user identified by userId. This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

userId - the primary key of the user

type - the relationship type

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getRelationActivitiesCount

public static int getRelationActivitiesCount(long userId)
                                      throws java.rmi.RemoteException

Returns the number of activities done by users in a relationship with the user identified by userId.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getRelationActivitiesCount

public static int getRelationActivitiesCount(long userId,
                                             int type)
                                      throws java.rmi.RemoteException

Returns the number of activities done by users in a relationship of type type with the user identified by userId. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

type - the relationship type

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getUserActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getUserActivities(long userId,
                                                                                     int start,
                                                                                     int end)
                                                                              throws java.rmi.RemoteException

Returns a range of all the activities done by the user.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getUserActivitiesCount

public static int getUserActivitiesCount(long userId)
                                  throws java.rmi.RemoteException

Returns the number of activities done by the user.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getUserGroupsActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getUserGroupsActivities(long userId,
                                                                                           int start,
                                                                                           int end)
                                                                                    throws java.rmi.RemoteException

Returns a range of all the activities done in the user's groups. This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getUserGroupsActivitiesCount

public static int getUserGroupsActivitiesCount(long userId)
                                        throws java.rmi.RemoteException

Returns the number of activities done in user's groups. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getUserGroupsAndOrganizationsActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getUserGroupsAndOrganizationsActivities(long userId,
                                                                                                           int start,
                                                                                                           int end)
                                                                                                    throws java.rmi.RemoteException

Returns a range of all the activities done in the user's groups and organizations. This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getUserGroupsAndOrganizationsActivitiesCount

public static int getUserGroupsAndOrganizationsActivitiesCount(long userId)
                                                        throws java.rmi.RemoteException

Returns the number of activities done in user's groups and organizations. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException

getUserOrganizationsActivities

public static com.liferay.social.kernel.model.SocialActivitySoap[] getUserOrganizationsActivities(long userId,
                                                                                                  int start,
                                                                                                  int end)
                                                                                           throws java.rmi.RemoteException

Returns a range of all activities done in the user's organizations. This method only finds activities without mirrors.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil#ALL_POS will return the full result set.

Parameters:

userId - the primary key of the user

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the range of matching activities

Throws:

java.rmi.RemoteException

getUserOrganizationsActivitiesCount

public static int getUserOrganizationsActivitiesCount(long userId)
                                               throws java.rmi.RemoteException

Returns the number of activities done in the user's organizations. This method only counts activities without mirrors.

Parameters:

userId - the primary key of the user

Returns:

the number of matching activities

Throws:

java.rmi.RemoteException