Interface UserGroupService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
UserGroupServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupService
extends BaseService
Provides the remote service interface for UserGroup. 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}
-
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
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.
-
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
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
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
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup fetchUserGroup(long userGroupId) throws PortalException 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
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup fetchUserGroupByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
getGtUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size) -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroup(long userGroupId) throws PortalException 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
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroup(String name) throws PortalException Returns the user group with the name.- Parameters:
name
- the user group's name- Returns:
- the user group with the name
- Throws:
PortalException
-
getUserGroupByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Throws:
PortalException
-
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserGroups(long companyId) throws PortalException - Throws:
PortalException
-
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserGroups(long companyId, String name, int start, int end) -
getUserGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserGroupsCount(long companyId, String name) -
getUserUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserUserGroups(long userId) throws PortalException 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, String keywords, LinkedHashMap<String, Object> params) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
UserGroup updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateUserGroup
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
-