Liferay 6.1.2-ce-ga3

com.liferay.portal.service.http
Class UserGroupServiceSoap

java.lang.Object
  extended by com.liferay.portal.service.http.UserGroupServiceSoap

public class UserGroupServiceSoap
extends Object

This class provides a 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/secure/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

See Also:
UserGroupServiceHttp, UserGroupSoap, UserGroupServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
UserGroupServiceSoap()
           
 
Method Summary
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 UserGroupSoap addUserGroup(String name, String description)
          Adds a user group.
static void deleteUserGroup(long userGroupId)
          Deletes the user group.
static UserGroupSoap getUserGroup(long userGroupId)
          Returns the user group with the primary key.
static UserGroupSoap getUserGroup(String name)
          Returns the user group with the name.
static 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 UserGroupSoap updateUserGroup(long userGroupId, String name, String description)
          Updates the user group.
 
Methods inherited from class java.lang.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:
PortalException - if a group or user group with the primary key could not be found, or if the user did not have permission to assign group members
SystemException - if a system exception occurred
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:
PortalException - if a team or user group with the primary key could not be found, or if the user did not have permission to assign team members
SystemException - if a system exception occurred
RemoteException

addUserGroup

public static UserGroupSoap addUserGroup(String name,
                                         String description)
                                  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
Returns:
the user group
Throws:
PortalException - if the user group's information was invalid or if the user did not have permission to add the user group
SystemException - if a system exception occurred
RemoteException

deleteUserGroup

public static void deleteUserGroup(long userGroupId)
                            throws RemoteException
Deletes the user group.

Parameters:
userGroupId - the primary key of the user group
Throws:
PortalException - if a user group with the primary key could not be found, if the user did not have permission to delete the user group, or if the user group had a workflow in approved status
SystemException - if a system exception occurred
RemoteException

getUserGroup

public static UserGroupSoap getUserGroup(long userGroupId)
                                  throws RemoteException
Returns the user group with the primary key.

Parameters:
userGroupId - the primary key of the user group
Returns:
Returns the user group with the primary key
Throws:
PortalException - if a user group with the primary key could not be found or if the user did not have permission to view the user group
SystemException - if a system exception occurred
RemoteException

getUserGroup

public static UserGroupSoap getUserGroup(String name)
                                  throws RemoteException
Returns the user group with the name.

Parameters:
name - the user group's name
Returns:
Returns the user group with the name
Throws:
PortalException - if a user group with the name could not be found or if the user did not have permission to view the user group
SystemException - if a system exception occurred
RemoteException

getUserUserGroups

public static 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:
PortalException - if the current user did not have permission to view the user or any one of the user group members
SystemException - if a system exception occurred
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:
PortalException - if the user did not have permission to assign group members
SystemException - if a system exception occurred
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:
PortalException - if the user did not have permission to assign team members
SystemException - if a system exception occurred
RemoteException

updateUserGroup

public static UserGroupSoap updateUserGroup(long userGroupId,
                                            String name,
                                            String description)
                                     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
Returns:
the user group
Throws:
PortalException - if a user group with the primary key was not found, if the new information was invalid, or if the user did not have permission to update the user group information
SystemException - if a system exception occurred
RemoteException

Liferay 6.1.2-ce-ga3