Class UserGroupLocalServiceWrapper
- All Implemented Interfaces:
BaseLocalService,CTService<UserGroup>,PersistedModelLocalService,ServiceWrapper<UserGroupLocalService>,UserGroupLocalService
UserGroupLocalService.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddGroupUserGroup(long groupId, long userGroupId) booleanaddGroupUserGroup(long groupId, UserGroup userGroup) booleanaddGroupUserGroups(long groupId, long[] userGroupIds) booleanaddGroupUserGroups(long groupId, List<UserGroup> userGroups) addOrUpdateUserGroup(String externalReferenceCode, long userId, long companyId, String name, String description, ServiceContext serviceContext) booleanaddTeamUserGroup(long teamId, long userGroupId) booleanaddTeamUserGroup(long teamId, UserGroup userGroup) booleanaddTeamUserGroups(long teamId, long[] userGroupIds) booleanaddTeamUserGroups(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.booleanaddUserUserGroup(long userId, long userGroupId) booleanaddUserUserGroup(long userId, UserGroup userGroup) booleanaddUserUserGroups(long userId, long[] userGroupIds) booleanaddUserUserGroups(long userId, List<UserGroup> userGroups) voidclearGroupUserGroups(long groupId) voidclearTeamUserGroups(long teamId) voidclearUserUserGroups(long userId) createPersistedModel(Serializable primaryKeyObj) createUserGroup(long userGroupId) Creates a new user group with the primary key.voiddeleteGroupUserGroup(long groupId, long userGroupId) voiddeleteGroupUserGroup(long groupId, UserGroup userGroup) voiddeleteGroupUserGroups(long groupId, long[] userGroupIds) voiddeleteGroupUserGroups(long groupId, List<UserGroup> userGroups) deletePersistedModel(PersistedModel persistedModel) voiddeleteTeamUserGroup(long teamId, long userGroupId) voiddeleteTeamUserGroup(long teamId, UserGroup userGroup) voiddeleteTeamUserGroups(long teamId, long[] userGroupIds) voiddeleteTeamUserGroups(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.voiddeleteUserGroups(long companyId) voiddeleteUserUserGroup(long userId, long userGroupId) voiddeleteUserUserGroup(long userId, UserGroup userGroup) voiddeleteUserUserGroups(long userId, long[] userGroupIds) voiddeleteUserUserGroups(long userId, List<UserGroup> userGroups) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(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.longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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) intgetGroupUserGroupsCount(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) intgetTeamUserGroupsCount(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) intReturns the number of user groups.intgetUserGroupsCount(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) intgetUserUserGroupsCount(long userId) booleanhasGroupUserGroup(long groupId, long userGroupId) booleanhasGroupUserGroups(long groupId) booleanhasTeamUserGroup(long teamId, long userGroupId) booleanhasTeamUserGroups(long teamId) booleanhasUserUserGroup(long userId, long userGroupId) booleanhasUserUserGroups(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.intsearchCount(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andOperator) Returns the number of user groups that match the name and description.intsearchCount(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) voidsetGroupUserGroups(long groupId, long[] userGroupIds) voidsetTeamUserGroups(long teamId, long[] userGroupIds) voidsetUserUserGroups(long userId, long[] userGroupIds) voidsetWrappedService(UserGroupLocalService userGroupLocalService) voidunsetGroupUserGroups(long groupId, long[] userGroupIds) Removes the user groups from the group.voidunsetTeamUserGroups(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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel
-
Constructor Details
-
UserGroupLocalServiceWrapper
public UserGroupLocalServiceWrapper() -
UserGroupLocalServiceWrapper
-
-
Method Details
-
addGroupUserGroup
public boolean addGroupUserGroup(long groupId, long userGroupId) - Specified by:
addGroupUserGroupin interfaceUserGroupLocalService
-
addGroupUserGroup
- Specified by:
addGroupUserGroupin interfaceUserGroupLocalService
-
addGroupUserGroups
- Specified by:
addGroupUserGroupsin interfaceUserGroupLocalService
-
addGroupUserGroups
public boolean addGroupUserGroups(long groupId, long[] userGroupIds) - Specified by:
addGroupUserGroupsin interfaceUserGroupLocalService
-
addOrUpdateUserGroup
public UserGroup addOrUpdateUserGroup(String externalReferenceCode, long userId, long companyId, String name, String description, ServiceContext serviceContext) throws PortalException - Specified by:
addOrUpdateUserGroupin interfaceUserGroupLocalService- Throws:
PortalException
-
addTeamUserGroup
public boolean addTeamUserGroup(long teamId, long userGroupId) - Specified by:
addTeamUserGroupin interfaceUserGroupLocalService
-
addTeamUserGroup
- Specified by:
addTeamUserGroupin interfaceUserGroupLocalService
-
addTeamUserGroups
- Specified by:
addTeamUserGroupsin interfaceUserGroupLocalService
-
addTeamUserGroups
public boolean addTeamUserGroups(long teamId, long[] userGroupIds) - Specified by:
addTeamUserGroupsin interfaceUserGroupLocalService
-
addUserGroup
public 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.
- Specified by:
addUserGroupin interfaceUserGroupLocalService- 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.
- Specified by:
addUserGroupin interfaceUserGroupLocalService- Parameters:
userGroup- the user group- Returns:
- the user group that was added
-
addUserUserGroup
- Specified by:
addUserUserGroupin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
addUserUserGroup
- Specified by:
addUserUserGroupin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
addUserUserGroups
- Specified by:
addUserUserGroupsin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
addUserUserGroups
- Specified by:
addUserUserGroupsin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
clearGroupUserGroups
public void clearGroupUserGroups(long groupId) - Specified by:
clearGroupUserGroupsin interfaceUserGroupLocalService
-
clearTeamUserGroups
public void clearTeamUserGroups(long teamId) - Specified by:
clearTeamUserGroupsin interfaceUserGroupLocalService
-
clearUserUserGroups
public void clearUserUserGroups(long userId) - Specified by:
clearUserUserGroupsin interfaceUserGroupLocalService
-
createPersistedModel
- Specified by:
createPersistedModelin interfacePersistedModelLocalService- Specified by:
createPersistedModelin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
createUserGroup
Creates a new user group with the primary key. Does not add the user group to the database.- Specified by:
createUserGroupin interfaceUserGroupLocalService- Parameters:
userGroupId- the primary key for the new user group- Returns:
- the new user group
-
deleteGroupUserGroup
public void deleteGroupUserGroup(long groupId, long userGroupId) - Specified by:
deleteGroupUserGroupin interfaceUserGroupLocalService
-
deleteGroupUserGroup
- Specified by:
deleteGroupUserGroupin interfaceUserGroupLocalService
-
deleteGroupUserGroups
- Specified by:
deleteGroupUserGroupsin interfaceUserGroupLocalService
-
deleteGroupUserGroups
public void deleteGroupUserGroups(long groupId, long[] userGroupIds) - Specified by:
deleteGroupUserGroupsin interfaceUserGroupLocalService
-
deletePersistedModel
- Specified by:
deletePersistedModelin interfacePersistedModelLocalService- Specified by:
deletePersistedModelin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
deleteTeamUserGroup
public void deleteTeamUserGroup(long teamId, long userGroupId) - Specified by:
deleteTeamUserGroupin interfaceUserGroupLocalService
-
deleteTeamUserGroup
- Specified by:
deleteTeamUserGroupin interfaceUserGroupLocalService
-
deleteTeamUserGroups
- Specified by:
deleteTeamUserGroupsin interfaceUserGroupLocalService
-
deleteTeamUserGroups
public void deleteTeamUserGroups(long teamId, long[] userGroupIds) - Specified by:
deleteTeamUserGroupsin interfaceUserGroupLocalService
-
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.
- Specified by:
deleteUserGroupin interfaceUserGroupLocalService- 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 foundPortalException
-
deleteUserGroup
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.
- Specified by:
deleteUserGroupin interfaceUserGroupLocalService- Parameters:
userGroup- the user group- Returns:
- the user group that was removed
- Throws:
PortalExceptionPortalException
-
deleteUserGroups
- Specified by:
deleteUserGroupsin interfaceUserGroupLocalService- Throws:
PortalException
-
deleteUserUserGroup
public void deleteUserUserGroup(long userId, long userGroupId) - Specified by:
deleteUserUserGroupin interfaceUserGroupLocalService
-
deleteUserUserGroup
- Specified by:
deleteUserUserGroupin interfaceUserGroupLocalService
-
deleteUserUserGroups
- Specified by:
deleteUserUserGroupsin interfaceUserGroupLocalService
-
deleteUserUserGroups
public void deleteUserUserGroups(long userId, long[] userGroupIds) - Specified by:
deleteUserUserGroupsin interfaceUserGroupLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacePersistedModelLocalService- Specified by:
dslQueryin interfaceUserGroupLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacePersistedModelLocalService- Specified by:
dslQueryCountin interfaceUserGroupLocalService
-
dynamicQuery
- Specified by:
dynamicQueryin interfaceUserGroupLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin interfaceUserGroupLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserGroupModelImpl.- Specified by:
dynamicQueryin interfaceUserGroupLocalService- 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
public <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserGroupModelImpl.- Specified by:
dynamicQueryin interfaceUserGroupLocalService- 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
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfaceUserGroupLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfaceUserGroupLocalService- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchUserGroup
- Specified by:
fetchUserGroupin interfaceUserGroupLocalService
-
fetchUserGroup
- Specified by:
fetchUserGroupin interfaceUserGroupLocalService
-
fetchUserGroupByExternalReferenceCode
public UserGroup fetchUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId) - Specified by:
fetchUserGroupByExternalReferenceCodein interfaceUserGroupLocalService
-
fetchUserGroupByUuidAndCompanyId
Returns the user group with the matching UUID and company.- Specified by:
fetchUserGroupByUuidAndCompanyIdin interfaceUserGroupLocalService- Parameters:
uuid- the user group's UUIDcompanyId- the primary key of the company- Returns:
- the matching user group, or
nullif a matching user group could not be found
-
getActionableDynamicQuery
- Specified by:
getActionableDynamicQueryin interfaceUserGroupLocalService
-
getExportActionableDynamicQuery
public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQueryin interfaceUserGroupLocalService
-
getGroupPrimaryKeys
public long[] getGroupPrimaryKeys(long userGroupId) Returns the groupIds of the groups associated with the user group.- Specified by:
getGroupPrimaryKeysin interfaceUserGroupLocalService- Parameters:
userGroupId- the userGroupId of the user group- Returns:
- long[] the groupIds of groups associated with the user group
-
getGroupUserGroups
- Specified by:
getGroupUserGroupsin interfaceUserGroupLocalService
-
getGroupUserGroups
- Specified by:
getGroupUserGroupsin interfaceUserGroupLocalService
-
getGroupUserGroups
public List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getGroupUserGroupsin interfaceUserGroupLocalService
-
getGroupUserGroupsCount
public int getGroupUserGroupsCount(long groupId) - Specified by:
getGroupUserGroupsCountin interfaceUserGroupLocalService
-
getGroupUserUserGroups
- Specified by:
getGroupUserUserGroupsin interfaceUserGroupLocalService- Throws:
PortalException
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQueryin interfaceUserGroupLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfaceUserGroupLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModelin interfacePersistedModelLocalService- Specified by:
getPersistedModelin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
getTeamPrimaryKeys
public long[] getTeamPrimaryKeys(long userGroupId) Returns the teamIds of the teams associated with the user group.- Specified by:
getTeamPrimaryKeysin interfaceUserGroupLocalService- Parameters:
userGroupId- the userGroupId of the user group- Returns:
- long[] the teamIds of teams associated with the user group
-
getTeamUserGroups
- Specified by:
getTeamUserGroupsin interfaceUserGroupLocalService
-
getTeamUserGroups
- Specified by:
getTeamUserGroupsin interfaceUserGroupLocalService
-
getTeamUserGroups
public List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getTeamUserGroupsin interfaceUserGroupLocalService
-
getTeamUserGroupsCount
public int getTeamUserGroupsCount(long teamId) - Specified by:
getTeamUserGroupsCountin interfaceUserGroupLocalService
-
getUserGroup
Returns the user group with the primary key.- Specified by:
getUserGroupin interfaceUserGroupLocalService- 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 foundPortalException
-
getUserGroup
Returns the user group with the name.- Specified by:
getUserGroupin interfaceUserGroupLocalService- 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
public UserGroup getUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException - Specified by:
getUserGroupByExternalReferenceCodein interfaceUserGroupLocalService- Throws:
PortalException
-
getUserGroupByUuidAndCompanyId
Returns the user group with the matching UUID and company.- Specified by:
getUserGroupByUuidAndCompanyIdin interfaceUserGroupLocalService- 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 foundPortalException
-
getUserGroups
Returns a range of all the user groups.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.UserGroupModelImpl.- Specified by:
getUserGroupsin interfaceUserGroupLocalService- 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.- Specified by:
getUserGroupsin interfaceUserGroupLocalService- Parameters:
companyId- the primary key of the user groups' company- Returns:
- the user groups belonging to the company
-
getUserGroups
- Specified by:
getUserGroupsin interfaceUserGroupLocalService
-
getUserGroups
public List<UserGroup> getUserGroups(long companyId, String name, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getUserGroupsin interfaceUserGroupLocalService
-
getUserGroups
Returns all the user groups with the primary keys.- Specified by:
getUserGroupsin interfaceUserGroupLocalService- Parameters:
userGroupIds- the primary keys of the user groups- Returns:
- the user groups with the primary keys
- Throws:
PortalException
-
getUserGroupsCount
public int getUserGroupsCount()Returns the number of user groups.- Specified by:
getUserGroupsCountin interfaceUserGroupLocalService- Returns:
- the number of user groups
-
getUserGroupsCount
- Specified by:
getUserGroupsCountin interfaceUserGroupLocalService
-
getUserPrimaryKeys
public long[] getUserPrimaryKeys(long userGroupId) Returns the userIds of the users associated with the user group.- Specified by:
getUserPrimaryKeysin interfaceUserGroupLocalService- Parameters:
userGroupId- the userGroupId of the user group- Returns:
- long[] the userIds of users associated with the user group
-
getUserUserGroups
- Specified by:
getUserUserGroupsin interfaceUserGroupLocalService
-
getUserUserGroups
- Specified by:
getUserUserGroupsin interfaceUserGroupLocalService
-
getUserUserGroups
public List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getUserUserGroupsin interfaceUserGroupLocalService
-
getUserUserGroupsCount
public int getUserUserGroupsCount(long userId) - Specified by:
getUserUserGroupsCountin interfaceUserGroupLocalService
-
hasGroupUserGroup
public boolean hasGroupUserGroup(long groupId, long userGroupId) - Specified by:
hasGroupUserGroupin interfaceUserGroupLocalService
-
hasGroupUserGroups
public boolean hasGroupUserGroups(long groupId) - Specified by:
hasGroupUserGroupsin interfaceUserGroupLocalService
-
hasTeamUserGroup
public boolean hasTeamUserGroup(long teamId, long userGroupId) - Specified by:
hasTeamUserGroupin interfaceUserGroupLocalService
-
hasTeamUserGroups
public boolean hasTeamUserGroups(long teamId) - Specified by:
hasTeamUserGroupsin interfaceUserGroupLocalService
-
hasUserUserGroup
public boolean hasUserUserGroup(long userId, long userGroupId) - Specified by:
hasUserUserGroupin interfaceUserGroupLocalService
-
hasUserUserGroups
public boolean hasUserUserGroups(long userId) - Specified by:
hasUserUserGroupsin interfaceUserGroupLocalService
-
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
searchin interfaceUserGroupLocalService- 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 seeUserGroupFinderstart- 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 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
searchin interfaceUserGroupLocalService- 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.UserGroupIndexerstart- 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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
searchin interfaceUserGroupLocalService- 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 seeUserGroupFinderandOperator- 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
public 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtoQueryUtil#ALL_POSwill return the full result set.- Specified by:
searchin interfaceUserGroupLocalService- 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.UserGroupIndexerandSearch- 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
Returns the number of user groups that match the keywords- Specified by:
searchCountin interfaceUserGroupLocalService- 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:
searchCountin interfaceUserGroupLocalService- 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 seeUserGroupFinderandOperator- whether every field must match its keywords or just one field- Returns:
- the number of matching user groups
- See Also:
-
searchUserGroups
public BaseModelSearchResult<UserGroup> searchUserGroups(long companyId, String keywords, LinkedHashMap<String, Object> params, int start, int end, Sort sort) throws PortalException- Specified by:
searchUserGroupsin interfaceUserGroupLocalService- Throws:
PortalException
-
searchUserGroups
public BaseModelSearchResult<UserGroup> searchUserGroups(long companyId, String name, String description, LinkedHashMap<String, Object> params, boolean andSearch, int start, int end, Sort sort) throws PortalException- Specified by:
searchUserGroupsin interfaceUserGroupLocalService- Throws:
PortalException
-
setGroupUserGroups
public void setGroupUserGroups(long groupId, long[] userGroupIds) - Specified by:
setGroupUserGroupsin interfaceUserGroupLocalService
-
setTeamUserGroups
public void setTeamUserGroups(long teamId, long[] userGroupIds) - Specified by:
setTeamUserGroupsin interfaceUserGroupLocalService
-
setUserUserGroups
- Specified by:
setUserUserGroupsin interfaceUserGroupLocalService- Throws:
PortalExceptionPortalException
-
unsetGroupUserGroups
public void unsetGroupUserGroups(long groupId, long[] userGroupIds) Removes the user groups from the group.- Specified by:
unsetGroupUserGroupsin interfaceUserGroupLocalService- Parameters:
groupId- the primary key of the groupuserGroupIds- the primary keys of the user groups
-
unsetTeamUserGroups
public void unsetTeamUserGroups(long teamId, long[] userGroupIds) Removes the user groups from the team.- Specified by:
unsetTeamUserGroupsin interfaceUserGroupLocalService- Parameters:
teamId- the primary key of the teamuserGroupIds- the primary keys of the user groups
-
updateExternalReferenceCode
public UserGroup updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode) throws PortalException - Specified by:
updateExternalReferenceCodein interfaceUserGroupLocalService- Throws:
PortalException
-
updateUserGroup
public UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException Updates the user group.- Specified by:
updateUserGroupin interfaceUserGroupLocalService- 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.
- Specified by:
updateUserGroupin interfaceUserGroupLocalService- Parameters:
userGroup- the user group- Returns:
- the user group that was updated
-
getBasePersistence
- Specified by:
getBasePersistencein interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistencein interfaceCTService<UserGroup>- Specified by:
getCTPersistencein interfaceUserGroupLocalService
-
getModelClass
- Specified by:
getModelClassin interfaceCTService<UserGroup>- Specified by:
getModelClassin interfaceUserGroupLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<UserGroup>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfaceCTService<UserGroup>- Specified by:
updateWithUnsafeFunctionin interfaceUserGroupLocalService- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedServicein interfaceServiceWrapper<UserGroupLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfaceServiceWrapper<UserGroupLocalService>
-