Class UserGroupServiceWrapper
Object
com.liferay.portal.kernel.service.UserGroupServiceWrapper
- All Implemented Interfaces:
BaseService
,ServiceWrapper<UserGroupService>
,UserGroupService
public class UserGroupServiceWrapper
extends Object
implements ServiceWrapper<UserGroupService>, UserGroupService
Provides a wrapper for
UserGroupService
.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addGroupUserGroups
(long groupId, long[] userGroupIds) Adds the user groups to the group.addOrUpdateUserGroup
(String externalReferenceCode, String name, String description, ServiceContext serviceContext) void
addTeamUserGroups
(long teamId, long[] userGroupIds) Adds the user groups to the teamaddUserGroup
(String name, String description, ServiceContext serviceContext) Adds a user group.void
deleteUserGroup
(long userGroupId) Deletes the user group.fetchUserGroup
(long userGroupId) Fetches the user group with the primary key.fetchUserGroupByExternalReferenceCode
(long companyId, String externalReferenceCode) getGtUserGroups
(long gtUserGroupId, long companyId, long parentUserGroupId, int size) Returns the OSGi service identifier.getUserGroup
(long userGroupId) Returns the user group with the primary key.getUserGroup
(String name) Returns the user group with the name.getUserGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) getUserGroups
(long companyId) getUserGroups
(long companyId, String name, int start, int end) 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.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.int
searchCount
(long companyId, String keywords, LinkedHashMap<String, Object> params) Returns the number of user groups that match the keywordsvoid
setWrappedService
(UserGroupService userGroupService) 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.updateExternalReferenceCode
(UserGroup userGroup, String externalReferenceCode) updateUserGroup
(long userGroupId, String name, String description, ServiceContext serviceContext) Updates the user group.
-
Constructor Details
-
UserGroupServiceWrapper
public UserGroupServiceWrapper() -
UserGroupServiceWrapper
-
-
Method Details
-
addGroupUserGroups
Adds the user groups to the group.- Specified by:
addGroupUserGroups
in interfaceUserGroupService
- Parameters:
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups- Throws:
PortalException
-
addOrUpdateUserGroup
public UserGroup addOrUpdateUserGroup(String externalReferenceCode, String name, String description, ServiceContext serviceContext) throws PortalException - Specified by:
addOrUpdateUserGroup
in interfaceUserGroupService
- Throws:
PortalException
-
addTeamUserGroups
Adds the user groups to the team- Specified by:
addTeamUserGroups
in interfaceUserGroupService
- Parameters:
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups- Throws:
PortalException
-
addUserGroup
public 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.
- Specified by:
addUserGroup
in interfaceUserGroupService
- 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.- Specified by:
deleteUserGroup
in interfaceUserGroupService
- Parameters:
userGroupId
- the primary key of the user group- Throws:
PortalException
-
fetchUserGroup
Fetches the user group with the primary key.- Specified by:
fetchUserGroup
in interfaceUserGroupService
- Parameters:
userGroupId
- the primary key of the user group- Returns:
- the user group with the primary key
- Throws:
PortalException
-
fetchUserGroupByExternalReferenceCode
public UserGroup fetchUserGroupByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException - Specified by:
fetchUserGroupByExternalReferenceCode
in interfaceUserGroupService
- Throws:
PortalException
-
getGtUserGroups
public List<UserGroup> getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size) - Specified by:
getGtUserGroups
in interfaceUserGroupService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceUserGroupService
- Returns:
- the OSGi service identifier
-
getUserGroup
Returns the user group with the primary key.- Specified by:
getUserGroup
in interfaceUserGroupService
- 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.- Specified by:
getUserGroup
in interfaceUserGroupService
- Parameters:
name
- the user group's name- Returns:
- the user group with the name
- Throws:
PortalException
-
getUserGroupByExternalReferenceCode
public UserGroup getUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Specified by:
getUserGroupByExternalReferenceCode
in interfaceUserGroupService
- Throws:
PortalException
-
getUserGroups
- Specified by:
getUserGroups
in interfaceUserGroupService
- Throws:
PortalException
-
getUserGroups
- Specified by:
getUserGroups
in interfaceUserGroupService
-
getUserGroupsCount
- Specified by:
getUserGroupsCount
in interfaceUserGroupService
-
getUserUserGroups
Returns all the user groups to which the user belongs.- Specified by:
getUserUserGroups
in interfaceUserGroupService
- Parameters:
userId
- the primary key of the user- Returns:
- the user groups to which the user belongs
- Throws:
PortalException
-
search
public 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.- Specified by:
search
in interfaceUserGroupService
- 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 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.- Specified by:
search
in interfaceUserGroupService
- 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- Specified by:
searchCount
in interfaceUserGroupService
- 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 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.- Specified by:
searchCount
in interfaceUserGroupService
- 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.- Specified by:
unsetGroupUserGroups
in interfaceUserGroupService
- 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.- Specified by:
unsetTeamUserGroups
in interfaceUserGroupService
- Parameters:
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups- Throws:
PortalException
-
updateExternalReferenceCode
public UserGroup updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCode
in interfaceUserGroupService
- Throws:
PortalException
-
updateUserGroup
public UserGroup updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException Updates the user group.- Specified by:
updateUserGroup
in interfaceUserGroupService
- 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
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<UserGroupService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<UserGroupService>
-