public class UserGroupServiceWrapper extends Object implements ServiceWrapper<UserGroupService>, UserGroupService
UserGroupService.UserGroupService| Constructor and Description |
|---|
UserGroupServiceWrapper() |
UserGroupServiceWrapper(UserGroupService userGroupService) |
| Modifier and Type | Method and Description |
|---|---|
void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
Adds the user groups to the group.
|
UserGroup |
addOrUpdateUserGroup(String externalReferenceCode,
String name,
String description,
ServiceContext serviceContext) |
void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team
|
UserGroup |
addUserGroup(String name,
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.
|
UserGroup |
fetchUserGroupByExternalReferenceCode(long companyId,
String externalReferenceCode) |
List<UserGroup> |
getGtUserGroups(long gtUserGroupId,
long companyId,
long parentUserGroupId,
int size) |
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key.
|
UserGroup |
getUserGroup(String name)
Returns the user group with the name.
|
List<UserGroup> |
getUserGroups(long companyId) |
List<UserGroup> |
getUserGroups(long companyId,
String name,
int start,
int end) |
int |
getUserGroupsCount(long companyId,
String name) |
List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs.
|
UserGroupService |
getWrappedService() |
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.
|
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.
|
int |
searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of 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.
|
void |
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.
|
UserGroup |
updateExternalReferenceCode(UserGroup userGroup,
String externalReferenceCode) |
UserGroup |
updateUserGroup(long userGroupId,
String name,
String description,
ServiceContext serviceContext)
Updates the user group.
|
public UserGroupServiceWrapper()
public UserGroupServiceWrapper(UserGroupService userGroupService)
public void addGroupUserGroups(long groupId,
long[] userGroupIds)
throws PortalException
addGroupUserGroups in interface UserGroupServicegroupId - the primary key of the groupuserGroupIds - the primary keys of the user groupsPortalExceptionpublic UserGroup addOrUpdateUserGroup(String externalReferenceCode, String name, String description, ServiceContext serviceContext) throws PortalException
addOrUpdateUserGroup in interface UserGroupServicePortalExceptionpublic void addTeamUserGroups(long teamId,
long[] userGroupIds)
throws PortalException
addTeamUserGroups in interface UserGroupServiceteamId - the primary key of the teamuserGroupIds - the primary keys of the user groupsPortalExceptionpublic UserGroup addUserGroup(String name, 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.
addUserGroup in interface UserGroupServicename - 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.PortalExceptionpublic void deleteUserGroup(long userGroupId)
throws PortalException
deleteUserGroup in interface UserGroupServiceuserGroupId - the primary key of the user groupPortalExceptionpublic UserGroup fetchUserGroup(long userGroupId) throws PortalException
fetchUserGroup in interface UserGroupServiceuserGroupId - the primary key of the user groupPortalExceptionpublic UserGroup fetchUserGroupByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException
fetchUserGroupByExternalReferenceCode in interface UserGroupServicePortalExceptionpublic List<UserGroup> getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
getGtUserGroups in interface UserGroupServicepublic String getOSGiServiceIdentifier()
getOSGiServiceIdentifier in interface UserGroupServicepublic UserGroup getUserGroup(long userGroupId) throws PortalException
getUserGroup in interface UserGroupServiceuserGroupId - the primary key of the user groupPortalExceptionpublic UserGroup getUserGroup(String name) throws PortalException
getUserGroup in interface UserGroupServicename - the user group's namePortalExceptionpublic List<UserGroup> getUserGroups(long companyId) throws PortalException
getUserGroups in interface UserGroupServicePortalExceptionpublic List<UserGroup> getUserGroups(long companyId, String name, int start, int end)
getUserGroups in interface UserGroupServicepublic int getUserGroupsCount(long companyId,
String name)
getUserGroupsCount in interface UserGroupServicepublic List<UserGroup> getUserUserGroups(long userId) throws PortalException
getUserUserGroups in interface UserGroupServiceuserId - the primary key of the userPortalExceptionpublic List<UserGroup> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<UserGroup> orderByComparator)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil#ALL_POS will return the full
result set.
search in interface UserGroupServicecompanyId - the primary key of the user group's companykeywords - the keywords (space separated), which may occur in the
user group's name or description (optionally null)params - the finder params (optionally null). For more
information see UserGroupFinderstart - 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
(optionally null)orderByComparatorUserGroupFinderpublic List<UserGroup> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<UserGroup> orderByComparator)
Useful when paginating results. Returns a maximum of end -
start instances. start and end are not
primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end to QueryUtil#ALL_POS will return the full
result set.
search in interface UserGroupServicecompanyId - the primary key of the user group's companyname - the user group's name (optionally null)description - the user group's description (optionally
null)params - the finder params (optionally null). For more
information see UserGroupFinderandOperator - 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
(optionally null)orderByComparatorUserGroupFinderpublic int searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
searchCount in interface UserGroupServicecompanyId - the primary key of the user group's companykeywords - the keywords (space separated), which may occur in the
user group's name or description (optionally null)params - the finder params (optionally null). For more
information see UserGroupFinderUserGroupFinderpublic int searchCount(long companyId,
String name,
String description,
LinkedHashMap<String,Object> params,
boolean andOperator)
searchCount in interface UserGroupServicecompanyId - the primary key of the user group's companyname - the user group's name (optionally null)description - the user group's description (optionally
null)params - the finder params (optionally null). For more
information see UserGroupFinderandOperator - whether every field must match its keywords or just
one fieldUserGroupFinderpublic void unsetGroupUserGroups(long groupId,
long[] userGroupIds)
throws PortalException
unsetGroupUserGroups in interface UserGroupServicegroupId - the primary key of the groupuserGroupIds - the primary keys of the user groupsPortalExceptionpublic void unsetTeamUserGroups(long teamId,
long[] userGroupIds)
throws PortalException
unsetTeamUserGroups in interface UserGroupServiceteamId - the primary key of the teamuserGroupIds - the primary keys of the user groupsPortalExceptionpublic UserGroup updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode) throws PortalException
updateExternalReferenceCode in interface UserGroupServicePortalExceptionpublic UserGroup updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException
updateUserGroup in interface UserGroupServiceuserGroupId - 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.PortalExceptionpublic UserGroupService getWrappedService()
getWrappedService in interface ServiceWrapper<UserGroupService>public void setWrappedService(UserGroupService userGroupService)
setWrappedService in interface ServiceWrapper<UserGroupService>