public class UserGroupServiceUtil
extends Object
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.UserGroupService
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 UserGroup |
addOrUpdateUserGroup(String externalReferenceCode,
String name,
String description,
ServiceContext serviceContext) |
static void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team
|
static 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) |
static List<UserGroup> |
getGtUserGroups(long gtUserGroupId,
long companyId,
long parentUserGroupId,
int size) |
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static UserGroupService |
getService() |
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 List<UserGroup> |
getUserGroups(long companyId) |
static List<UserGroup> |
getUserGroups(long companyId,
String name,
int start,
int end) |
static int |
getUserGroupsCount(long companyId,
String name) |
static List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs.
|
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.
|
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.
|
static int |
searchCount(long companyId,
String keywords,
LinkedHashMap<String,Object> params)
Returns the number of 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 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.
|
public static void addGroupUserGroups(long groupId, long[] userGroupIds) throws PortalException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groupsPortalException
public static UserGroup addOrUpdateUserGroup(String externalReferenceCode, String name, String description, ServiceContext serviceContext) throws PortalException
PortalException
public static void addTeamUserGroups(long teamId, long[] userGroupIds) throws PortalException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groupsPortalException
public static 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.
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
public static void deleteUserGroup(long userGroupId) throws PortalException
userGroupId
- the primary key of the user groupPortalException
public static UserGroup fetchUserGroup(long userGroupId) throws PortalException
userGroupId
- the primary key of the user groupPortalException
public static UserGroup fetchUserGroupByExternalReferenceCode(long companyId, String externalReferenceCode) throws PortalException
PortalException
public static List<UserGroup> getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
public static String getOSGiServiceIdentifier()
public static UserGroup getUserGroup(long userGroupId) throws PortalException
userGroupId
- the primary key of the user groupPortalException
public static UserGroup getUserGroup(String name) throws PortalException
name
- the user group's namePortalException
public static List<UserGroup> getUserGroups(long companyId) throws PortalException
PortalException
public static List<UserGroup> getUserGroups(long companyId, String name, int start, int end)
public static int getUserGroupsCount(long companyId, String name)
public static List<UserGroup> getUserUserGroups(long userId) throws PortalException
userId
- the primary key of the userPortalException
public static 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.
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 (optionally null
)params
- the finder params (optionally null
). For more
information see UserGroupFinder
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
(optionally null
)orderByComparator
UserGroupFinder
public static 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.
companyId
- 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 UserGroupFinder
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
(optionally null
)orderByComparator
UserGroupFinder
public static int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)
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 (optionally null
)params
- the finder params (optionally null
). For more
information see UserGroupFinder
UserGroupFinder
public static int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator)
companyId
- 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 UserGroupFinder
andOperator
- whether every field must match its keywords or just
one fieldUserGroupFinder
public static void unsetGroupUserGroups(long groupId, long[] userGroupIds) throws PortalException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groupsPortalException
public static void unsetTeamUserGroups(long teamId, long[] userGroupIds) throws PortalException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groupsPortalException
public static UserGroup updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode) throws PortalException
PortalException
public static UserGroup updateUserGroup(long userGroupId, String name, 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
public static UserGroupService getService()
public static void setService(UserGroupService service)