|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.http.UserGroupServiceSoap
@ProviderType public class UserGroupServiceSoap
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.
UserGroupServiceHttp
,
UserGroupSoap
,
UserGroupServiceUtil
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)
Deprecated. As of 6.2.0, replaced by addUserGroup(String, String,
ServiceContext) |
static UserGroupSoap |
addUserGroup(String name,
String description,
ServiceContext serviceContext)
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)
Deprecated. As of 6.2.0, replaced by updateUserGroup(long,
String, String, ServiceContext) |
static UserGroupSoap |
updateUserGroup(long userGroupId,
String name,
String description,
ServiceContext serviceContext)
Updates the user group. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserGroupServiceSoap()
Method Detail |
---|
public static void addGroupUserGroups(long groupId, long[] userGroupIds) throws RemoteException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
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
public static void addTeamUserGroups(long teamId, long[] userGroupIds) throws RemoteException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
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
public static UserGroupSoap addUserGroup(String name, String description) throws 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 description
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
public static UserGroupSoap addUserGroup(String name, String description, ServiceContext serviceContext) throws 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 group
SystemException
- if a system exception occurred
RemoteException
public static void deleteUserGroup(long userGroupId) throws RemoteException
userGroupId
- the primary key of the user group
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
public static UserGroupSoap getUserGroup(long userGroupId) throws RemoteException
userGroupId
- the primary key of the user group
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
public static UserGroupSoap getUserGroup(String name) throws RemoteException
name
- the user group's name
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
public static UserGroupSoap[] getUserUserGroups(long userId) throws RemoteException
userId
- the primary key of the user
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
public static void unsetGroupUserGroups(long groupId, long[] userGroupIds) throws RemoteException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
PortalException
- if the user did not have permission to assign
group members
SystemException
- if a system exception occurred
RemoteException
public static void unsetTeamUserGroups(long teamId, long[] userGroupIds) throws RemoteException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
PortalException
- if the user did not have permission to assign
team members
SystemException
- if a system exception occurred
RemoteException
public static UserGroupSoap updateUserGroup(long userGroupId, String name, String description) throws RemoteException
updateUserGroup(long,
String, String, ServiceContext)
userGroupId
- the primary key of the user groupname
- the user group's namedescription
- the the user group's description
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
public static UserGroupSoap updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) throws 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 information
SystemException
- if a system exception occurred
RemoteException
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |