|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@JSONWebService @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface UserGroupService
The interface for the user group remote service.
This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
UserGroupServiceUtil
,
UserGroupServiceBaseImpl
,
UserGroupServiceImpl
Method Summary | |
---|---|
void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
Adds the user groups to the group. |
void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team |
UserGroup |
addUserGroup(String name,
String description)
Adds a user group. |
void |
deleteUserGroup(long userGroupId)
Deletes the user group. |
String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key. |
UserGroup |
getUserGroup(String name)
Returns the user group with the name. |
List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs. |
void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
unsetGroupUserGroups(long groupId,
long[] userGroupIds)
Removes the user groups from the group. |
void |
unsetTeamUserGroups(long teamId,
long[] userGroupIds)
Removes the user groups from the team. |
UserGroup |
updateUserGroup(long userGroupId,
String name,
String description)
Updates the user group. |
Method Detail |
---|
String getBeanIdentifier()
void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanvoid addGroupUserGroups(long groupId, long[] userGroupIds) throws PortalException, SystemException
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 occurredvoid addTeamUserGroups(long teamId, long[] userGroupIds) throws PortalException, SystemException
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 occurredUserGroup addUserGroup(String name, String description) throws PortalException, SystemException
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 occurredvoid deleteUserGroup(long userGroupId) throws PortalException, SystemException
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@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroup(long userGroupId) throws PortalException, SystemException
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@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroup(String name) throws PortalException, SystemException
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@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserUserGroups(long userId) throws PortalException, SystemException
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 occurredvoid unsetGroupUserGroups(long groupId, long[] userGroupIds) throws PortalException, SystemException
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 occurredvoid unsetTeamUserGroups(long teamId, long[] userGroupIds) throws PortalException, SystemException
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 occurredUserGroup updateUserGroup(long userGroupId, String name, String description) throws PortalException, SystemException
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
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |