com.liferay.portal.service.http

Class UserGroupServiceSoap

Object

com.liferay.portal.service.http.UserGroupServiceSoap

@ProviderType
public class UserGroupServiceSoap
extends Object

Provides the SOAP utility for the UserGroupServiceUtil service utility. The static methods of this class calls 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 List, that is translated to an array of UserGroupSoap. If the method in the service utility returns a UserGroup, that is translated to a UserGroupSoap. 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:

UserGroupServiceHttp, UserGroupSoap, UserGroupServiceUtil

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
UserGroupServiceSoap()

Method Summary

Modifier and Type	Method and Description
static void	addGroupUserGroups(long groupId, long[] userGroupIds) Adds the user groups to the group.
static void	addTeamUserGroups(long teamId, long[] userGroupIds) Adds the user groups to the team
static com.liferay.portal.kernel.model.UserGroupSoap	addUserGroup(String name, String description) Deprecated. As of Newton (6.2.x), replaced by addUserGroup(String, String, ServiceContext)
static com.liferay.portal.kernel.model.UserGroupSoap	addUserGroup(String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Adds a user group.
static void	deleteUserGroup(long userGroupId) Deletes the user group.
static com.liferay.portal.kernel.model.UserGroupSoap	fetchUserGroup(long userGroupId) Fetches the user group with the primary key.
static com.liferay.portal.kernel.model.UserGroupSoap[]	getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
static com.liferay.portal.kernel.model.UserGroupSoap	getUserGroup(long userGroupId) Returns the user group with the primary key.
static com.liferay.portal.kernel.model.UserGroupSoap	getUserGroup(String name) Returns the user group with the name.
static com.liferay.portal.kernel.model.UserGroupSoap[]	getUserGroups(long companyId)
static com.liferay.portal.kernel.model.UserGroupSoap[]	getUserGroups(long companyId, String name, int start, int end)
static int	getUserGroupsCount(long companyId, String name)
static com.liferay.portal.kernel.model.UserGroupSoap[]	getUserUserGroups(long userId) Returns all the user groups to which the user belongs.
static void	unsetGroupUserGroups(long groupId, long[] userGroupIds) Removes the user groups from the group.
static void	unsetTeamUserGroups(long teamId, long[] userGroupIds) Removes the user groups from the team.
static com.liferay.portal.kernel.model.UserGroupSoap	updateUserGroup(long userGroupId, String name, String description) Deprecated. As of Newton (6.2.x), replaced by updateUserGroup(long, String, String, ServiceContext)
static com.liferay.portal.kernel.model.UserGroupSoap	updateUserGroup(long userGroupId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) Updates the user group.

Methods inherited from class Object

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

Constructor Detail

UserGroupServiceSoap

public UserGroupServiceSoap()

Method Detail

addGroupUserGroups

public static void addGroupUserGroups(long groupId,
                                      long[] userGroupIds)
                               throws RemoteException

Adds the user groups to the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

RemoteException

addTeamUserGroups

public static void addTeamUserGroups(long teamId,
                                     long[] userGroupIds)
                              throws RemoteException

Adds the user groups to the team

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

RemoteException

addUserGroup

@Deprecated
public static com.liferay.portal.kernel.model.UserGroupSoap addUserGroup(String name,
                                                                                     String description)
                                                                              throws RemoteException

Deprecated. As of Newton (6.2.x), replaced by addUserGroup(String, String, ServiceContext)

Adds a user group.

This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.

Parameters:

name - the user group's name

description - the user group's description

Returns:

the user group

Throws:

RemoteException

addUserGroup

public static com.liferay.portal.kernel.model.UserGroupSoap addUserGroup(String name,
                                                                         String description,
                                                                         com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                  throws RemoteException

Adds a user group.

This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.

Parameters:

name - the user group's name

description - the user group's description

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.

Returns:

the user group

Throws:

RemoteException

deleteUserGroup

public static void deleteUserGroup(long userGroupId)
                            throws RemoteException

Deletes the user group.

Parameters:

userGroupId - the primary key of the user group

Throws:

RemoteException

fetchUserGroup

public static com.liferay.portal.kernel.model.UserGroupSoap fetchUserGroup(long userGroupId)
                                                                    throws RemoteException

Fetches the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

RemoteException

getGtUserGroups

public static com.liferay.portal.kernel.model.UserGroupSoap[] getGtUserGroups(long gtUserGroupId,
                                                                              long companyId,
                                                                              long parentUserGroupId,
                                                                              int size)
                                                                       throws RemoteException

Throws:

RemoteException

getUserGroup

public static com.liferay.portal.kernel.model.UserGroupSoap getUserGroup(long userGroupId)
                                                                  throws RemoteException

Returns the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

RemoteException

getUserGroup

public static com.liferay.portal.kernel.model.UserGroupSoap getUserGroup(String name)
                                                                  throws RemoteException

Returns the user group with the name.

Parameters:

name - the user group's name

Returns:

the user group with the name

Throws:

RemoteException

getUserGroups

public static com.liferay.portal.kernel.model.UserGroupSoap[] getUserGroups(long companyId)
                                                                     throws RemoteException

Throws:

RemoteException

getUserGroups

public static com.liferay.portal.kernel.model.UserGroupSoap[] getUserGroups(long companyId,
                                                                            String name,
                                                                            int start,
                                                                            int end)
                                                                     throws RemoteException

Throws:

RemoteException

getUserGroupsCount

public static int getUserGroupsCount(long companyId,
                                     String name)
                              throws RemoteException

Throws:

RemoteException

getUserUserGroups

public static com.liferay.portal.kernel.model.UserGroupSoap[] getUserUserGroups(long userId)
                                                                         throws RemoteException

Returns all the user groups to which the user belongs.

Parameters:

userId - the primary key of the user

Returns:

the user groups to which the user belongs

Throws:

RemoteException

unsetGroupUserGroups

public static void unsetGroupUserGroups(long groupId,
                                        long[] userGroupIds)
                                 throws RemoteException

Removes the user groups from the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

RemoteException

unsetTeamUserGroups

public static void unsetTeamUserGroups(long teamId,
                                       long[] userGroupIds)
                                throws RemoteException

Removes the user groups from the team.

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

RemoteException

updateUserGroup

@Deprecated
public static com.liferay.portal.kernel.model.UserGroupSoap updateUserGroup(long userGroupId,
                                                                                        String name,
                                                                                        String description)
                                                                                 throws RemoteException

Deprecated. As of Newton (6.2.x), replaced by updateUserGroup(long, String, String, ServiceContext)

Updates the user group.

Parameters:

userGroupId - the primary key of the user group

name - the user group's name

description - the the user group's description

Returns:

the user group

Throws:

RemoteException

updateUserGroup

public static com.liferay.portal.kernel.model.UserGroupSoap updateUserGroup(long userGroupId,
                                                                            String name,
                                                                            String description,
                                                                            com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                                     throws RemoteException

Updates the user group.

Parameters:

userGroupId - the primary key of the user group

name - the user group's name

description - the the user group's description

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.

Returns:

the user group

Throws:

RemoteException