@ProviderType
public class UserGroupServiceUtil
extends java.lang.Object
com.liferay.portal.service.impl.UserGroupServiceImpl and is the
primary access point for service operations in application layer code running
on a remote server. Methods of this service are expected to have security
checks based on the propagated JAAS credentials because this service can be
accessed remotely.UserGroupService,
UserGroupServiceBaseImpl,
com.liferay.portal.service.impl.UserGroupServiceImpl| Constructor and Description |
|---|
UserGroupServiceUtil() |
| 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 UserGroup |
addUserGroup(java.lang.String name,
java.lang.String description)
Deprecated.
As of 6.2.0, replaced by
addUserGroup(String, String,
ServiceContext) |
static UserGroup |
addUserGroup(java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Adds a user group.
|
static void |
deleteUserGroup(long userGroupId)
Deletes the user group.
|
static UserGroup |
fetchUserGroup(long userGroupId)
Fetches the user group with the primary key.
|
static java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
static UserGroupService |
getService() |
static UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key.
|
static UserGroup |
getUserGroup(java.lang.String name)
Returns the user group with the name.
|
static java.util.List<UserGroup> |
getUserGroups(long companyId) |
static java.util.List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs.
|
static void |
setBeanIdentifier(java.lang.String beanIdentifier)
Sets the Spring bean ID for this bean.
|
void |
setService(UserGroupService service)
Deprecated.
As of 6.2.0
|
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 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) |
static UserGroup |
updateUserGroup(long userGroupId,
java.lang.String name,
java.lang.String description,
ServiceContext serviceContext)
Updates the user group.
|
public static 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 memberspublic static void 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 public static 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 grouppublic static UserGroup 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 grouppublic static void 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 statuspublic static 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 grouppublic static java.lang.String getBeanIdentifier()
public static 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 grouppublic static 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
grouppublic static java.util.List<UserGroup> getUserGroups(long companyId) throws PortalException
PortalExceptionpublic static 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 memberspublic static void setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanpublic static void 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 memberspublic static void 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 public static 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 informationpublic static UserGroup 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 informationpublic static UserGroupService getService()
@Deprecated public void setService(UserGroupService service)