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 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
setWrappedService
(UserGroupLocalService userGroupLocalService) 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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods 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:
addGroupUserGroup
in interfaceUserGroupLocalService
-
addGroupUserGroup
- Specified by:
addGroupUserGroup
in interfaceUserGroupLocalService
-
addGroupUserGroups
- Specified by:
addGroupUserGroups
in interfaceUserGroupLocalService
-
addGroupUserGroups
public boolean addGroupUserGroups(long groupId, long[] userGroupIds) - Specified by:
addGroupUserGroups
in interfaceUserGroupLocalService
-
addOrUpdateUserGroup
public UserGroup addOrUpdateUserGroup(String externalReferenceCode, long userId, long companyId, String name, String description, ServiceContext serviceContext) throws PortalException - Specified by:
addOrUpdateUserGroup
in interfaceUserGroupLocalService
- Throws:
PortalException
-
addTeamUserGroup
public boolean addTeamUserGroup(long teamId, long userGroupId) - Specified by:
addTeamUserGroup
in interfaceUserGroupLocalService
-
addTeamUserGroup
- Specified by:
addTeamUserGroup
in interfaceUserGroupLocalService
-
addTeamUserGroups
- Specified by:
addTeamUserGroups
in interfaceUserGroupLocalService
-
addTeamUserGroups
public boolean addTeamUserGroups(long teamId, long[] userGroupIds) - Specified by:
addTeamUserGroups
in 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:
addUserGroup
in 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:
addUserGroup
in interfaceUserGroupLocalService
- Parameters:
userGroup
- the user group- Returns:
- the user group that was added
-
addUserUserGroup
- Specified by:
addUserUserGroup
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
addUserUserGroup
- Specified by:
addUserUserGroup
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
addUserUserGroups
- Specified by:
addUserUserGroups
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
addUserUserGroups
- Specified by:
addUserUserGroups
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
clearGroupUserGroups
public void clearGroupUserGroups(long groupId) - Specified by:
clearGroupUserGroups
in interfaceUserGroupLocalService
-
clearTeamUserGroups
public void clearTeamUserGroups(long teamId) - Specified by:
clearTeamUserGroups
in interfaceUserGroupLocalService
-
clearUserUserGroups
public void clearUserUserGroups(long userId) - Specified by:
clearUserUserGroups
in interfaceUserGroupLocalService
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Specified by:
createPersistedModel
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
createUserGroup
Creates a new user group with the primary key. Does not add the user group to the database.- Specified by:
createUserGroup
in 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:
deleteGroupUserGroup
in interfaceUserGroupLocalService
-
deleteGroupUserGroup
- Specified by:
deleteGroupUserGroup
in interfaceUserGroupLocalService
-
deleteGroupUserGroups
- Specified by:
deleteGroupUserGroups
in interfaceUserGroupLocalService
-
deleteGroupUserGroups
public void deleteGroupUserGroups(long groupId, long[] userGroupIds) - Specified by:
deleteGroupUserGroups
in interfaceUserGroupLocalService
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Specified by:
deletePersistedModel
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
deleteTeamUserGroup
public void deleteTeamUserGroup(long teamId, long userGroupId) - Specified by:
deleteTeamUserGroup
in interfaceUserGroupLocalService
-
deleteTeamUserGroup
- Specified by:
deleteTeamUserGroup
in interfaceUserGroupLocalService
-
deleteTeamUserGroups
- Specified by:
deleteTeamUserGroups
in interfaceUserGroupLocalService
-
deleteTeamUserGroups
public void deleteTeamUserGroups(long teamId, long[] userGroupIds) - Specified by:
deleteTeamUserGroups
in 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:
deleteUserGroup
in 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:
deleteUserGroup
in interfaceUserGroupLocalService
- Parameters:
userGroup
- the user group- Returns:
- the user group that was removed
- Throws:
PortalException
PortalException
-
deleteUserGroups
- Specified by:
deleteUserGroups
in interfaceUserGroupLocalService
- Throws:
PortalException
-
deleteUserUserGroup
public void deleteUserUserGroup(long userId, long userGroupId) - Specified by:
deleteUserUserGroup
in interfaceUserGroupLocalService
-
deleteUserUserGroup
- Specified by:
deleteUserUserGroup
in interfaceUserGroupLocalService
-
deleteUserUserGroups
- Specified by:
deleteUserUserGroups
in interfaceUserGroupLocalService
-
deleteUserUserGroups
public void deleteUserUserGroups(long userId, long[] userGroupIds) - Specified by:
deleteUserUserGroups
in interfaceUserGroupLocalService
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
- Specified by:
dslQuery
in interfaceUserGroupLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
- Specified by:
dslQueryCount
in interfaceUserGroupLocalService
-
dynamicQuery
- Specified by:
dynamicQuery
in interfaceUserGroupLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in 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 - 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
.- Specified by:
dynamicQuery
in 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 - 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
.- Specified by:
dynamicQuery
in 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:
dynamicQueryCount
in 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:
dynamicQueryCount
in 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:
fetchUserGroup
in interfaceUserGroupLocalService
-
fetchUserGroup
- Specified by:
fetchUserGroup
in interfaceUserGroupLocalService
-
fetchUserGroupByExternalReferenceCode
public UserGroup fetchUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId) - Specified by:
fetchUserGroupByExternalReferenceCode
in interfaceUserGroupLocalService
-
fetchUserGroupByUuidAndCompanyId
Returns the user group with the matching UUID and company.- Specified by:
fetchUserGroupByUuidAndCompanyId
in interfaceUserGroupLocalService
- 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
- Specified by:
getActionableDynamicQuery
in interfaceUserGroupLocalService
-
getExportActionableDynamicQuery
public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQuery
in interfaceUserGroupLocalService
-
getGroupPrimaryKeys
public long[] getGroupPrimaryKeys(long userGroupId) Returns the groupIds of the groups associated with the user group.- Specified by:
getGroupPrimaryKeys
in interfaceUserGroupLocalService
- Parameters:
userGroupId
- the userGroupId of the user group- Returns:
- long[] the groupIds of groups associated with the user group
-
getGroupUserGroups
- Specified by:
getGroupUserGroups
in interfaceUserGroupLocalService
-
getGroupUserGroups
- Specified by:
getGroupUserGroups
in interfaceUserGroupLocalService
-
getGroupUserGroups
public List<UserGroup> getGroupUserGroups(long groupId, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getGroupUserGroups
in interfaceUserGroupLocalService
-
getGroupUserGroupsCount
public int getGroupUserGroupsCount(long groupId) - Specified by:
getGroupUserGroupsCount
in interfaceUserGroupLocalService
-
getGroupUserUserGroups
- Specified by:
getGroupUserUserGroups
in interfaceUserGroupLocalService
- Throws:
PortalException
-
getIndexableActionableDynamicQuery
- Specified by:
getIndexableActionableDynamicQuery
in interfaceUserGroupLocalService
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in interfaceUserGroupLocalService
- Returns:
- the OSGi service identifier
-
getPersistedModel
- Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Specified by:
getPersistedModel
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
getTeamPrimaryKeys
public long[] getTeamPrimaryKeys(long userGroupId) Returns the teamIds of the teams associated with the user group.- Specified by:
getTeamPrimaryKeys
in interfaceUserGroupLocalService
- Parameters:
userGroupId
- the userGroupId of the user group- Returns:
- long[] the teamIds of teams associated with the user group
-
getTeamUserGroups
- Specified by:
getTeamUserGroups
in interfaceUserGroupLocalService
-
getTeamUserGroups
- Specified by:
getTeamUserGroups
in interfaceUserGroupLocalService
-
getTeamUserGroups
public List<UserGroup> getTeamUserGroups(long teamId, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getTeamUserGroups
in interfaceUserGroupLocalService
-
getTeamUserGroupsCount
public int getTeamUserGroupsCount(long teamId) - Specified by:
getTeamUserGroupsCount
in interfaceUserGroupLocalService
-
getUserGroup
Returns the user group with the primary key.- Specified by:
getUserGroup
in 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:
getUserGroup
in 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:
getUserGroupByExternalReferenceCode
in interfaceUserGroupLocalService
- Throws:
PortalException
-
getUserGroupByUuidAndCompanyId
Returns the user group with the matching UUID and company.- Specified by:
getUserGroupByUuidAndCompanyId
in 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 - 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
.- Specified by:
getUserGroups
in 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:
getUserGroups
in interfaceUserGroupLocalService
- Parameters:
companyId
- the primary key of the user groups' company- Returns:
- the user groups belonging to the company
-
getUserGroups
- Specified by:
getUserGroups
in interfaceUserGroupLocalService
-
getUserGroups
public List<UserGroup> getUserGroups(long companyId, String name, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getUserGroups
in interfaceUserGroupLocalService
-
getUserGroups
Returns all the user groups with the primary keys.- Specified by:
getUserGroups
in 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:
getUserGroupsCount
in interfaceUserGroupLocalService
- Returns:
- the number of user groups
-
getUserGroupsCount
- Specified by:
getUserGroupsCount
in interfaceUserGroupLocalService
-
getUserPrimaryKeys
public long[] getUserPrimaryKeys(long userGroupId) Returns the userIds of the users associated with the user group.- Specified by:
getUserPrimaryKeys
in interfaceUserGroupLocalService
- Parameters:
userGroupId
- the userGroupId of the user group- Returns:
- long[] the userIds of users associated with the user group
-
getUserUserGroups
- Specified by:
getUserUserGroups
in interfaceUserGroupLocalService
-
getUserUserGroups
- Specified by:
getUserUserGroups
in interfaceUserGroupLocalService
-
getUserUserGroups
public List<UserGroup> getUserUserGroups(long userId, int start, int end, OrderByComparator<UserGroup> orderByComparator) - Specified by:
getUserUserGroups
in interfaceUserGroupLocalService
-
getUserUserGroupsCount
public int getUserUserGroupsCount(long userId) - Specified by:
getUserUserGroupsCount
in interfaceUserGroupLocalService
-
hasGroupUserGroup
public boolean hasGroupUserGroup(long groupId, long userGroupId) - Specified by:
hasGroupUserGroup
in interfaceUserGroupLocalService
-
hasGroupUserGroups
public boolean hasGroupUserGroups(long groupId) - Specified by:
hasGroupUserGroups
in interfaceUserGroupLocalService
-
hasTeamUserGroup
public boolean hasTeamUserGroup(long teamId, long userGroupId) - Specified by:
hasTeamUserGroup
in interfaceUserGroupLocalService
-
hasTeamUserGroups
public boolean hasTeamUserGroups(long teamId) - Specified by:
hasTeamUserGroups
in interfaceUserGroupLocalService
-
hasUserUserGroup
public boolean hasUserUserGroup(long userId, long userGroupId) - Specified by:
hasUserUserGroup
in interfaceUserGroupLocalService
-
hasUserUserGroups
public boolean hasUserUserGroups(long userId) - Specified by:
hasUserUserGroups
in 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 - 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.- Specified by:
search
in 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
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
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 - 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.- Specified by:
search
in 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.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
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 - 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.- Specified by:
search
in 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 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
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 - 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.- Specified by:
search
in 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.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
Returns the number of user groups that match the keywords- Specified by:
searchCount
in 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:
searchCount
in 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 seeUserGroupFinder
andOperator
- 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:
searchUserGroups
in 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:
searchUserGroups
in interfaceUserGroupLocalService
- Throws:
PortalException
-
setGroupUserGroups
public void setGroupUserGroups(long groupId, long[] userGroupIds) - Specified by:
setGroupUserGroups
in interfaceUserGroupLocalService
-
setTeamUserGroups
public void setTeamUserGroups(long teamId, long[] userGroupIds) - Specified by:
setTeamUserGroups
in interfaceUserGroupLocalService
-
setUserUserGroups
- Specified by:
setUserUserGroups
in interfaceUserGroupLocalService
- Throws:
PortalException
PortalException
-
unsetGroupUserGroups
public void unsetGroupUserGroups(long groupId, long[] userGroupIds) Removes the user groups from the group.- Specified by:
unsetGroupUserGroups
in 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:
unsetTeamUserGroups
in 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:
updateExternalReferenceCode
in 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:
updateUserGroup
in 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:
updateUserGroup
in interfaceUserGroupLocalService
- Parameters:
userGroup
- the user group- Returns:
- the user group that was updated
-
getBasePersistence
- Specified by:
getBasePersistence
in interfacePersistedModelLocalService
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<UserGroup>
- Specified by:
getCTPersistence
in interfaceUserGroupLocalService
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<UserGroup>
- Specified by:
getModelClass
in interfaceUserGroupLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<UserGroup>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<UserGroup>
- Specified by:
updateWithUnsafeFunction
in interfaceUserGroupLocalService
- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedService
in interfaceServiceWrapper<UserGroupLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfaceServiceWrapper<UserGroupLocalService>
-