@AccessControlled @JSONWebService @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface UserGroupService extends BaseService
UserGroupServiceUtil,
UserGroupServiceBaseImpl,
com.liferay.portal.service.impl.UserGroupServiceImpl| Modifier and Type | Method and Description |
|---|---|
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(java.lang.String name,
java.lang.String description)
Deprecated.
As of 6.2.0, replaced by
addUserGroup(String, String,
ServiceContext) |
UserGroup |
addUserGroup(java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Adds a user group.
|
void |
deleteUserGroup(long userGroupId)
Deletes the user group.
|
UserGroup |
fetchUserGroup(long userGroupId)
Fetches the user group with the primary key.
|
java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key.
|
UserGroup |
getUserGroup(java.lang.String name)
Returns the user group with the name.
|
java.util.List<UserGroup> |
getUserGroups(long companyId) |
java.util.List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs.
|
void |
setBeanIdentifier(java.lang.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,
java.lang.String name,
java.lang.String description)
Deprecated.
As of 6.2.0, replaced by
updateUserGroup(long,
String, String, ServiceContext) |
UserGroup |
updateUserGroup(long userGroupId,
java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Updates the user group.
|
void addGroupUserGroups(long groupId,
long[] userGroupIds)
throws PortalException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
group membersvoid addTeamUserGroups(long teamId,
long[] userGroupIds)
throws PortalException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
team members@Deprecated UserGroup addUserGroup(java.lang.String name, java.lang.String description) throws PortalException
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 groupUserGroup addUserGroup(java.lang.String name, java.lang.String description, ServiceContext serviceContext) throws PortalException
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 groupvoid deleteUserGroup(long userGroupId)
throws PortalException
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 status@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup fetchUserGroup(long userGroupId) throws PortalException
userGroupId - the primary key of the user groupPortalException - if the user did not have permission to view the
user groupjava.lang.String getBeanIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroup(java.lang.String name) throws PortalException
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 group@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroup(long userGroupId) throws PortalException
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
group@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<UserGroup> getUserGroups(long companyId) throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<UserGroup> getUserUserGroups(long userId) throws PortalException
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 membersvoid setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanvoid unsetGroupUserGroups(long groupId,
long[] userGroupIds)
throws PortalException
groupId - the primary key of the groupuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
group membersvoid unsetTeamUserGroups(long teamId,
long[] userGroupIds)
throws PortalException
teamId - the primary key of the teamuserGroupIds - the primary keys of the user groupsPortalException - if the user did not have permission to assign
team members@Deprecated UserGroup updateUserGroup(long userGroupId, java.lang.String name, java.lang.String description) throws PortalException
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 informationUserGroup updateUserGroup(long userGroupId, java.lang.String name, java.lang.String description, ServiceContext serviceContext) throws PortalException
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