Class UserGroupServiceUtil
Object
com.liferay.portal.kernel.service.UserGroupServiceUtil
Provides the remote service utility for UserGroup. This utility wraps
com.liferay.portal.service.impl.UserGroupServiceImpl
and is an
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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic void
addGroupUserGroups
(long groupId, long[] userGroupIds) Adds the user groups to the group.static UserGroup
addOrUpdateUserGroup
(String externalReferenceCode, String name, String description, ServiceContext serviceContext) static void
addTeamUserGroups
(long teamId, long[] userGroupIds) Adds the user groups to the teamstatic UserGroup
addUserGroup
(String name, 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 UserGroup
fetchUserGroupByExternalReferenceCode
(long companyId, String externalReferenceCode) getGtUserGroups
(long gtUserGroupId, long companyId, long parentUserGroupId, int size) static String
Returns the OSGi service identifier.static UserGroupService
static UserGroup
getUserGroup
(long userGroupId) Returns the user group with the primary key.static UserGroup
getUserGroup
(String name) Returns the user group with the name.static UserGroup
getUserGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) getUserGroups
(long companyId) getUserGroups
(long companyId, String name, int start, int end) static int
getUserGroupsCount
(long companyId, String name) getUserUserGroups
(long userId) Returns all the user groups to which the user belongs.search
(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<UserGroup> orderByComparator) Returns an ordered range of all the user groups that match the name and description.search
(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<UserGroup> orderByComparator) Returns an ordered range of all the user groups that match the keywords.static int
searchCount
(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of user groups that match the name and description.static int
searchCount
(long companyId, String keywords, LinkedHashMap<String, Object> params) Returns the number of user groups that match the keywordsstatic void
setService
(UserGroupService service) 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
updateExternalReferenceCode
(UserGroup userGroup, String externalReferenceCode) static UserGroup
updateUserGroup
(long userGroupId, String name, String description, ServiceContext serviceContext) Updates the user group.
-
Constructor Details
-
UserGroupServiceUtil
public UserGroupServiceUtil()
-
-
Method Details
-
addGroupUserGroups
Adds the user groups to the group.- Parameters:
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups- Throws:
PortalException
-
addOrUpdateUserGroup
public static UserGroup addOrUpdateUserGroup(String externalReferenceCode, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addTeamUserGroups
Adds the user groups to the team- Parameters:
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups- Throws:
PortalException
-
addUserGroup
public static UserGroup addUserGroup(String name, String description, ServiceContext serviceContext) throws PortalException Adds a user group.This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.
- Parameters:
name
- the user group's namedescription
- the user group's descriptionserviceContext
- the service context to be applied (optionallynull
). Can set expando bridge attributes for the user group.- Returns:
- the user group
- Throws:
PortalException
-
deleteUserGroup
Deletes the user group.- Parameters:
userGroupId
- the primary key of the user group- Throws:
PortalException
-
fetchUserGroup
Fetches the user group with the primary key.- Parameters:
userGroupId
- the primary key of the user group- Returns:
- the user group with the primary key
- Throws:
PortalException
-
fetchUserGroupByExternalReferenceCode
public static UserGroup fetchUserGroupByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
getGtUserGroups
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getUserGroup
Returns the user group with the primary key.- Parameters:
userGroupId
- the primary key of the user group- Returns:
- the user group with the primary key
- Throws:
PortalException
-
getUserGroup
Returns the user group with the name.- Parameters:
name
- the user group's name- Returns:
- the user group with the name
- Throws:
PortalException
-
getUserGroupByExternalReferenceCode
public static UserGroup getUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getUserGroups
- Throws:
PortalException
-
getUserGroups
-
getUserGroupsCount
-
getUserUserGroups
Returns all the user groups to which the user belongs.- Parameters:
userId
- the primary key of the user- Returns:
- the user groups to which the user belongs
- Throws:
PortalException
-
search
public static List<UserGroup> search(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, OrderByComparator<UserGroup> orderByComparator) Returns an ordered range of all the user groups that match the keywords.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the user group's companykeywords
- the keywords (space separated), which may occur in the user group's name or description (optionallynull
)params
- the finder params (optionallynull
). For more information seeUserGroupFinder
start
- the lower bound of the range of user groups to returnend
- the upper bound of the range of user groups to return (not inclusive)orderByComparator
- the comparator to order the user groups (optionallynull
)- Returns:
- the matching user groups ordered by comparator
orderByComparator
- See Also:
-
search
public static List<UserGroup> search(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator, int start, int end, OrderByComparator<UserGroup> orderByComparator) Returns an ordered range of all the user groups that match the name and description.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
toQueryUtil#ALL_POS
will return the full result set.- Parameters:
companyId
- the primary key of the user group's companyname
- the user group's name (optionallynull
)description
- the user group's description (optionallynull
)params
- the finder params (optionallynull
). For more information seeUserGroupFinder
andOperator
- whether every field must match its keywords or just one fieldstart
- the lower bound of the range of user groups to returnend
- the upper bound of the range of user groups to return (not inclusive)orderByComparator
- the comparator to order the user groups (optionallynull
)- Returns:
- the matching user groups ordered by comparator
orderByComparator
- See Also:
-
searchCount
Returns the number of user groups that match the keywords- Parameters:
companyId
- the primary key of the user group's companykeywords
- the keywords (space separated), which may occur in the user group's name or description (optionallynull
)params
- the finder params (optionallynull
). For more information seeUserGroupFinder
- Returns:
- the number of matching user groups
- See Also:
-
searchCount
public static int searchCount(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of user groups that match the name and description.- Parameters:
companyId
- the primary key of the user group's companyname
- the user group's name (optionallynull
)description
- the user group's description (optionallynull
)params
- the finder params (optionallynull
). For more information seeUserGroupFinder
andOperator
- whether every field must match its keywords or just one field- Returns:
- the number of matching user groups
- See Also:
-
unsetGroupUserGroups
Removes the user groups from the group.- Parameters:
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups- Throws:
PortalException
-
unsetTeamUserGroups
Removes the user groups from the team.- Parameters:
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups- Throws:
PortalException
-
updateExternalReferenceCode
public static UserGroup updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateUserGroup
public static UserGroup updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException Updates the user group.- Parameters:
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 (optionallynull
). Can set expando bridge attributes for the user group.- Returns:
- the user group
- Throws:
PortalException
-
getService
-
setService
-