@ProviderType
public class UserGroupServiceSoap
extends java.lang.Object
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.
UserGroupServiceHttp,
UserGroupSoap,
UserGroupServiceUtil| Constructor and Description |
|---|
UserGroupServiceSoap() |
| 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.model.UserGroupSoap |
addUserGroup(java.lang.String name,
java.lang.String description)
Deprecated.
As of 6.2.0, replaced by
addUserGroup(String, String,
ServiceContext) |
static com.liferay.portal.model.UserGroupSoap |
addUserGroup(java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a user group.
|
static void |
deleteUserGroup(long userGroupId)
Deletes the user group.
|
static com.liferay.portal.model.UserGroupSoap |
fetchUserGroup(long userGroupId)
Fetches the user group with the primary key.
|
static com.liferay.portal.model.UserGroupSoap |
getUserGroup(long userGroupId)
Returns the user group with the primary key.
|
static com.liferay.portal.model.UserGroupSoap |
getUserGroup(java.lang.String name)
Returns the user group with the name.
|
static com.liferay.portal.model.UserGroupSoap[] |
getUserGroups(long companyId) |
static com.liferay.portal.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.model.UserGroupSoap |
updateUserGroup(long userGroupId,
java.lang.String name,
java.lang.String description)
Deprecated.
As of 6.2.0, replaced by
updateUserGroup(long,
String, String, ServiceContext) |
static com.liferay.portal.model.UserGroupSoap |
updateUserGroup(long userGroupId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
Updates the user group.
|
public static void addGroupUserGroups(long groupId,
long[] userGroupIds)
throws java.rmi.RemoteException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
group membersjava.rmi.RemoteExceptionpublic static void addTeamUserGroups(long teamId,
long[] userGroupIds)
throws java.rmi.RemoteException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
team membersjava.rmi.RemoteException@Deprecated
public static com.liferay.portal.model.UserGroupSoap addUserGroup(java.lang.String name,
java.lang.String description)
throws java.rmi.RemoteException
addUserGroup(String, String,
ServiceContext)This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.
name - the user group's namedescription - the user group's descriptionPortalException - if the user group's information was invalid
or if the user did not have permission to add the user groupjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.UserGroupSoap addUserGroup(java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.
name - the user group's namedescription - the user group's descriptionserviceContext - the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.PortalException - if the user group's information was invalid or if
the user did not have permission to add the user groupjava.rmi.RemoteExceptionpublic static void deleteUserGroup(long userGroupId)
throws java.rmi.RemoteException
userGroupId - the primary key of the user groupPortalException - 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 statusjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.UserGroupSoap fetchUserGroup(long userGroupId)
throws java.rmi.RemoteException
userGroupId - the primary key of the user groupPortalException - if the user did not have permission to view the
user groupjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.UserGroupSoap getUserGroup(long userGroupId)
throws java.rmi.RemoteException
userGroupId - the primary key of the user groupPortalException - if a user group with the primary key could not be
found or if the user did not have permission to view the user
groupjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.UserGroupSoap getUserGroup(java.lang.String name)
throws java.rmi.RemoteException
name - the user group's namePortalException - if a user group with the name could not be found
or if the user did not have permission to view the user groupjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.UserGroupSoap[] getUserGroups(long companyId)
throws java.rmi.RemoteException
java.rmi.RemoteExceptionpublic static com.liferay.portal.model.UserGroupSoap[] getUserUserGroups(long userId)
throws java.rmi.RemoteException
userId - the primary key of the userPortalException - if the current user did not have permission to
view the user or any one of the user group membersjava.rmi.RemoteExceptionpublic static void unsetGroupUserGroups(long groupId,
long[] userGroupIds)
throws java.rmi.RemoteException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
group membersjava.rmi.RemoteExceptionpublic static void unsetTeamUserGroups(long teamId,
long[] userGroupIds)
throws java.rmi.RemoteException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
team membersjava.rmi.RemoteException@Deprecated
public static com.liferay.portal.model.UserGroupSoap updateUserGroup(long userGroupId,
java.lang.String name,
java.lang.String description)
throws java.rmi.RemoteException
updateUserGroup(long,
String, String, ServiceContext)userGroupId - the primary key of the user groupname - the user group's namedescription - the the user group's descriptionPortalException - 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 informationjava.rmi.RemoteExceptionpublic static com.liferay.portal.model.UserGroupSoap updateUserGroup(long userGroupId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.service.ServiceContext serviceContext)
throws java.rmi.RemoteException
userGroupId - the primary key of the user groupname - the user group's namedescription - the the user group's descriptionserviceContext - the service context to be applied (optionally
null). Can set expando bridge attributes for the
user group.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 informationjava.rmi.RemoteException