Interface UserGroupLocalService
- All Superinterfaces:
BaseLocalService
,CTService<UserGroup>
,PersistedModelLocalService
- All Known Implementing Classes:
UserGroupLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionboolean
addGroupUserGroup
(long groupId, long userGroupId) boolean
addGroupUserGroup
(long groupId, UserGroup userGroup) boolean
addGroupUserGroups
(long groupId, long[] userGroupIds) boolean
addGroupUserGroups
(long groupId, List<UserGroup> userGroups) addOrUpdateUserGroup
(String externalReferenceCode, long userId, long companyId, String name, String description, ServiceContext serviceContext) boolean
addTeamUserGroup
(long teamId, long userGroupId) boolean
addTeamUserGroup
(long teamId, UserGroup userGroup) boolean
addTeamUserGroups
(long teamId, long[] userGroupIds) boolean
addTeamUserGroups
(long teamId, List<UserGroup> userGroups) addUserGroup
(long userId, long companyId, String name, String description, ServiceContext serviceContext) Adds a user group.addUserGroup
(UserGroup userGroup) Adds the user group to the database.boolean
addUserUserGroup
(long userId, long userGroupId) boolean
addUserUserGroup
(long userId, UserGroup userGroup) boolean
addUserUserGroups
(long userId, long[] userGroupIds) boolean
addUserUserGroups
(long userId, List<UserGroup> userGroups) void
clearGroupUserGroups
(long groupId) void
clearTeamUserGroups
(long teamId) void
clearUserUserGroups
(long userId) createPersistedModel
(Serializable primaryKeyObj) createUserGroup
(long userGroupId) Creates a new user group with the primary key.void
deleteGroupUserGroup
(long groupId, long userGroupId) void
deleteGroupUserGroup
(long groupId, UserGroup userGroup) void
deleteGroupUserGroups
(long groupId, long[] userGroupIds) void
deleteGroupUserGroups
(long groupId, List<UserGroup> userGroups) deletePersistedModel
(PersistedModel persistedModel) void
deleteTeamUserGroup
(long teamId, long userGroupId) void
deleteTeamUserGroup
(long teamId, UserGroup userGroup) void
deleteTeamUserGroups
(long teamId, long[] userGroupIds) void
deleteTeamUserGroups
(long teamId, List<UserGroup> userGroups) deleteUserGroup
(long userGroupId) Deletes the user group with the primary key from the database.deleteUserGroup
(UserGroup userGroup) Deletes the user group from the database.void
deleteUserGroups
(long companyId) void
deleteUserUserGroup
(long userId, long userGroupId) void
deleteUserUserGroup
(long userId, UserGroup userGroup) void
deleteUserUserGroups
(long userId, long[] userGroupIds) void
deleteUserUserGroups
(long userId, List<UserGroup> userGroups) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.<T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchUserGroup
(long userGroupId) fetchUserGroup
(long companyId, String name) fetchUserGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) fetchUserGroupByUuidAndCompanyId
(String uuid, long companyId) Returns the user group with the matching UUID and company.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) long[]
getGroupPrimaryKeys
(long userGroupId) Returns the groupIds of the groups associated with the user group.getGroupUserGroups
(long groupId) getGroupUserGroups
(long groupId, int start, int end) getGroupUserGroups
(long groupId, int start, int end, OrderByComparator<UserGroup> orderByComparator) int
getGroupUserGroupsCount
(long groupId) getGroupUserUserGroups
(long groupId, long userId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) long[]
getTeamPrimaryKeys
(long userGroupId) Returns the teamIds of the teams associated with the user group.getTeamUserGroups
(long teamId) getTeamUserGroups
(long teamId, int start, int end) getTeamUserGroups
(long teamId, int start, int end, OrderByComparator<UserGroup> orderByComparator) int
getTeamUserGroupsCount
(long teamId) getUserGroup
(long userGroupId) Returns the user group with the primary key.getUserGroup
(long companyId, String name) Returns the user group with the name.getUserGroupByExternalReferenceCode
(String externalReferenceCode, long companyId) getUserGroupByUuidAndCompanyId
(String uuid, long companyId) Returns the user group with the matching UUID and company.getUserGroups
(int start, int end) Returns a range of all the user groups.getUserGroups
(long companyId) Returns all the user groups belonging to the company.getUserGroups
(long[] userGroupIds) Returns all the user groups with the primary keys.getUserGroups
(long companyId, String name, int start, int end) getUserGroups
(long companyId, String name, int start, int end, OrderByComparator<UserGroup> orderByComparator) int
Returns the number of user groups.int
getUserGroupsCount
(long companyId, String name) long[]
getUserPrimaryKeys
(long userGroupId) Returns the userIds of the users associated with the user group.getUserUserGroups
(long userId) getUserUserGroups
(long userId, int start, int end) getUserUserGroups
(long userId, int start, int end, OrderByComparator<UserGroup> orderByComparator) int
getUserUserGroupsCount
(long userId) boolean
hasGroupUserGroup
(long groupId, long userGroupId) boolean
hasGroupUserGroups
(long groupId) boolean
hasTeamUserGroup
(long teamId, long userGroupId) boolean
hasTeamUserGroups
(long teamId) boolean
hasUserUserGroup
(long userId, long userGroupId) boolean
hasUserUserGroups
(long userId) search
(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort sort) Returns an ordered range of all the user groups that match the name and description.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, Sort sort) Returns an ordered range of all the user groups that match the keywords, using the indexer.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 keywordssearchUserGroups
(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort sort) searchUserGroups
(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) void
setGroupUserGroups
(long groupId, long[] userGroupIds) void
setTeamUserGroups
(long teamId, long[] userGroupIds) void
setUserUserGroups
(long userId, long[] userGroupIds) 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 companyId, long userGroupId, String name, String description, ServiceContext serviceContext) Updates the user group.updateUserGroup
(UserGroup userGroup) Updates the user group in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<UserGroup>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addGroupUserGroup
boolean addGroupUserGroup(long groupId, long userGroupId) -
addGroupUserGroup
-
addGroupUserGroups
-
addGroupUserGroups
boolean addGroupUserGroups(long groupId, long[] userGroupIds) -
addOrUpdateUserGroup
UserGroup addOrUpdateUserGroup(String externalReferenceCode, long userId, long companyId, String name, String description, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addTeamUserGroup
boolean addTeamUserGroup(long teamId, long userGroupId) -
addTeamUserGroup
-
addTeamUserGroups
-
addTeamUserGroups
boolean addTeamUserGroups(long teamId, long[] userGroupIds) -
addUserGroup
UserGroup addUserGroup(long userId, long companyId, 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. It is not necessary to make subsequent calls to setup default groups and resources for the user group.
- Parameters:
userId
- the primary key of the usercompanyId
- the primary key of the user group's companyname
- 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
-
addUserGroup
Adds the user group to the database. Also notifies the appropriate model listeners.Important: Inspect UserGroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userGroup
- the user group- Returns:
- the user group that was added
-
addUserUserGroup
- Throws:
PortalException
-
addUserUserGroup
- Throws:
PortalException
-
addUserUserGroups
- Throws:
PortalException
-
addUserUserGroups
- Throws:
PortalException
-
clearGroupUserGroups
void clearGroupUserGroups(long groupId) -
clearTeamUserGroups
void clearTeamUserGroups(long teamId) -
clearUserUserGroups
void clearUserUserGroups(long userId) -
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createUserGroup
Creates a new user group with the primary key. Does not add the user group to the database.- Parameters:
userGroupId
- the primary key for the new user group- Returns:
- the new user group
-
deleteGroupUserGroup
void deleteGroupUserGroup(long groupId, long userGroupId) -
deleteGroupUserGroup
-
deleteGroupUserGroups
-
deleteGroupUserGroups
void deleteGroupUserGroups(long groupId, long[] userGroupIds) -
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteTeamUserGroup
void deleteTeamUserGroup(long teamId, long userGroupId) -
deleteTeamUserGroup
-
deleteTeamUserGroups
-
deleteTeamUserGroups
void deleteTeamUserGroups(long teamId, long[] userGroupIds) -
deleteUserGroup
Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect UserGroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userGroupId
- the primary key of the user group- Returns:
- the user group that was removed
- Throws:
PortalException
- if a user group with the primary key could not be found
-
deleteUserGroup
@Indexable(type=DELETE) @SystemEvent(action=1, type=1) UserGroup deleteUserGroup(UserGroup userGroup) throws PortalException Deletes the user group from the database. Also notifies the appropriate model listeners.Important: Inspect UserGroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userGroup
- the user group- Returns:
- the user group that was removed
- Throws:
PortalException
-
deleteUserGroups
- Throws:
PortalException
-
deleteUserUserGroup
void deleteUserUserGroup(long userId, long userGroupId) -
deleteUserUserGroup
-
deleteUserUserGroups
-
deleteUserUserGroups
void deleteUserUserGroups(long userId, long[] userGroupIds) -
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.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
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserGroupModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.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
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserGroupModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchUserGroup
-
fetchUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup fetchUserGroup(long companyId, String name) -
fetchUserGroupByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup fetchUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchUserGroupByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup fetchUserGroupByUuidAndCompanyId(String uuid, long companyId) Returns the user group with the matching UUID and company.- Parameters:
uuid
- the user group's UUIDcompanyId
- the primary key of the company- Returns:
- the matching user group, or
null
if a matching user group could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getGroupPrimaryKeys
Returns the groupIds of the groups associated with the user group.- Parameters:
userGroupId
- the userGroupId of the user group- Returns:
- long[] the groupIds of groups associated with the user group
-
getGroupUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getGroupUserGroups(long groupId) -
getGroupUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getGroupUserGroups(long groupId, int start, int end) -
getGroupUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator<UserGroup> orderByComparator) -
getGroupUserGroupsCount
-
getGroupUserUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getGroupUserUserGroups(long groupId, long userId) throws PortalException - Throws:
PortalException
-
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getTeamPrimaryKeys
Returns the teamIds of the teams associated with the user group.- Parameters:
userGroupId
- the userGroupId of the user group- Returns:
- long[] the teamIds of teams associated with the user group
-
getTeamUserGroups
-
getTeamUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getTeamUserGroups(long teamId, int start, int end) -
getTeamUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator<UserGroup> orderByComparator) -
getTeamUserGroupsCount
-
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
- Throws:
PortalException
- if a user group with the primary key could not be found
-
getUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroup(long companyId, String name) throws PortalException Returns the user group with the name.- Parameters:
companyId
- the primary key of the user group's companyname
- the user group's name- Returns:
- 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
-
getUserGroupByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) UserGroup getUserGroupByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the user group with the matching UUID and company.- Parameters:
uuid
- the user group's UUIDcompanyId
- the primary key of the company- Returns:
- the matching user group
- Throws:
PortalException
- if a matching user group could not be found
-
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserGroups(int start, int end) Returns a range of all the user groups.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
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserGroupModelImpl
.- Parameters:
start
- the lower bound of the range of user groupsend
- the upper bound of the range of user groups (not inclusive)- Returns:
- the range of user groups
-
getUserGroups
Returns all the user groups belonging to the company.- Parameters:
companyId
- the primary key of the user groups' company- Returns:
- the user groups belonging to the company
-
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserGroups(long companyId, String name, int start, int end) -
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserGroups(long companyId, String name, int start, int end, OrderByComparator<UserGroup> orderByComparator) -
getUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserGroups(long[] userGroupIds) throws PortalException Returns all the user groups with the primary keys.- Parameters:
userGroupIds
- the primary keys of the user groups- Returns:
- the user groups with the primary keys
- Throws:
PortalException
-
getUserGroupsCount
Returns the number of user groups.- Returns:
- the number of user groups
-
getUserGroupsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getUserGroupsCount(long companyId, String name) -
getUserPrimaryKeys
Returns the userIds of the users associated with the user group.- Parameters:
userGroupId
- the userGroupId of the user group- Returns:
- long[] the userIds of users associated with the user group
-
getUserUserGroups
-
getUserUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserUserGroups(long userId, int start, int end) -
getUserUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator<UserGroup> orderByComparator) -
getUserUserGroupsCount
-
hasGroupUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasGroupUserGroup(long groupId, long userGroupId) -
hasGroupUserGroups
-
hasTeamUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasTeamUserGroup(long teamId, long userGroupId) -
hasTeamUserGroups
-
hasUserUserGroup
@Transactional(propagation=SUPPORTS, readOnly=true) boolean hasUserUserGroup(long userId, long userGroupId) -
hasUserUserGroups
-
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) Hits search(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) Returns an ordered range of all the user groups that match the keywords, using the indexer. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.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 seecom.liferay.user.groups.admin.web.search.UserGroupIndexer
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)sort
- the field and direction by which to sort (optionallynull
)- Returns:
- the matching user groups ordered by sort
- See Also:
-
com.liferay.user.groups.admin.web.search.UserGroupIndexer
-
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:
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) Hits search(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort sort) Returns an ordered range of all the user groups that match the name and description. It is preferable to use this method instead of the non-indexed version whenever possible for performance reasons.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 seecom.liferay.user.groups.admin.web.search.UserGroupIndexer
andSearch
- 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)sort
- the field and direction by which to sort (optionallynull
)- Returns:
- the matching user groups ordered by sort
- 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:
-
searchUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) BaseModelSearchResult<UserGroup> searchUserGroups(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) throws PortalException- Throws:
PortalException
-
searchUserGroups
@Transactional(propagation=SUPPORTS, readOnly=true) BaseModelSearchResult<UserGroup> searchUserGroups(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort sort) throws PortalException- Throws:
PortalException
-
setGroupUserGroups
void setGroupUserGroups(long groupId, long[] userGroupIds) -
setTeamUserGroups
void setTeamUserGroups(long teamId, long[] userGroupIds) -
setUserUserGroups
- Throws:
PortalException
-
unsetGroupUserGroups
void unsetGroupUserGroups(long groupId, long[] userGroupIds) Removes the user groups from the group.- Parameters:
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
-
unsetTeamUserGroups
void unsetTeamUserGroups(long teamId, long[] userGroupIds) Removes the user groups from the team.- Parameters:
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
-
updateExternalReferenceCode
@Indexable(type=REINDEX) UserGroup updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
updateUserGroup
UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException Updates the user group.- Parameters:
companyId
- the primary key of the user group's companyuserGroupId
- the primary key of the user groupname
- 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
-
updateUserGroup
Updates the user group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect UserGroupLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
userGroup
- the user group- Returns:
- the user group that was updated
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<UserGroup>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<UserGroup>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<UserGroup>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<UserGroup>
- Throws:
E extends Throwable
-