Package com.liferay.portal.kernel.service

Class UserGroupServiceWrapper

java.lang.Object

com.liferay.portal.kernel.service.UserGroupServiceWrapper

All Implemented Interfaces:

IdentifiableOSGiService, BaseService, ServiceWrapper<UserGroupService>, UserGroupService

public class UserGroupServiceWrapper
extends Object
implements ServiceWrapper<UserGroupService>, UserGroupService

Provides a wrapper for UserGroupService.

Author:

Brian Wing Shun Chan

See Also:

• UserGroupService

Generated:

Constructor Summary

Constructors

Constructor	Description
UserGroupServiceWrapper()
UserGroupServiceWrapper(UserGroupService userGroupService)

Method Summary

Modifier and Type	Method	Description
void	addGroupUserGroups(long groupId, long[] userGroupIds)	Adds the user groups to the group.
UserGroup	addOrUpdateUserGroup(String externalReferenceCode, String name, String description, ServiceContext serviceContext)
void	addTeamUserGroups(long teamId, long[] userGroupIds)	Adds the user groups to the team
UserGroup	addUserGroup(String externalReferenceCode, String name, String description, ServiceContext serviceContext)	Adds a user group.
void	deleteUserGroup(long userGroupId)	Deletes the user group.
UserGroup	fetchUserGroup(long userGroupId)	Fetches the user group with the primary key.
UserGroup	fetchUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId)
List<UserGroup>	getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
String	getOSGiServiceIdentifier()	Returns the OSGi service identifier.
UserGroup	getUserGroup(long userGroupId)	Returns the user group with the primary key.
UserGroup	getUserGroup(String name)	Returns the user group with the name.
UserGroup	getUserGroupByExternalReferenceCode(String externalReferenceCode, long companyId)
List<UserGroup>	getUserGroups(long companyId)
List<UserGroup>	getUserGroups(long companyId, String name, int start, int end)
int	getUserGroupsCount(long companyId, String name)
List<UserGroup>	getUserUserGroups(long userId)	Returns all the user groups to which the user belongs.
UserGroupService	getWrappedService()
List<UserGroup>	search(long companyId, String 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.
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.
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 keywords
void	setWrappedService(UserGroupService userGroupService)
void	unsetGroupUserGroups(long groupId, long[] userGroupIds)	Removes the user groups from the group.
void	unsetTeamUserGroups(long teamId, long[] userGroupIds)	Removes the user groups from the team.
UserGroup	updateExternalReferenceCode(UserGroup userGroup, String externalReferenceCode)
UserGroup	updateUserGroup(String externalReferenceCode, long userGroupId, String name, String description, ServiceContext serviceContext)	Updates the user group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

UserGroupServiceWrapper

public UserGroupServiceWrapper()

UserGroupServiceWrapper

public UserGroupServiceWrapper(UserGroupService userGroupService)

Method Details

addGroupUserGroups

public void addGroupUserGroups(long groupId,
 long[] userGroupIds)
                        throws PortalException

Adds the user groups to the group.

Specified by:

addGroupUserGroups in interface UserGroupService

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

PortalException

addOrUpdateUserGroup

public UserGroup addOrUpdateUserGroup(String externalReferenceCode,
 String name,
 String description,
 ServiceContext serviceContext)
                               throws PortalException

Specified by:

addOrUpdateUserGroup in interface UserGroupService

Throws:

PortalException

addTeamUserGroups

public void addTeamUserGroups(long teamId,
 long[] userGroupIds)
                       throws PortalException

Adds the user groups to the team

Specified by:

addTeamUserGroups in interface UserGroupService

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

PortalException

addUserGroup

public UserGroup addUserGroup(String externalReferenceCode,
 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.

Specified by:

addUserGroup in interface UserGroupService

Parameters:

externalReferenceCode - the user group's external reference code

name - the user group's name

description - the user group's description

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.

Returns:

the user group

Throws:

PortalException

deleteUserGroup

public void deleteUserGroup(long userGroupId)
                     throws PortalException

Deletes the user group.

Specified by:

deleteUserGroup in interface UserGroupService

Parameters:

userGroupId - the primary key of the user group

Throws:

PortalException

fetchUserGroup

public UserGroup fetchUserGroup(long userGroupId)
                         throws PortalException

Fetches the user group with the primary key.

Specified by:

fetchUserGroup in interface UserGroupService

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

PortalException

fetchUserGroupByExternalReferenceCode

public UserGroup fetchUserGroupByExternalReferenceCode(String externalReferenceCode,
 long companyId)
                                                throws PortalException

Specified by:

fetchUserGroupByExternalReferenceCode in interface UserGroupService

Throws:

PortalException

getGtUserGroups

public List<UserGroup> getGtUserGroups(long gtUserGroupId,
 long companyId,
 long parentUserGroupId,
 int size)

Specified by:

getGtUserGroups in interface UserGroupService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface IdentifiableOSGiService

Specified by:

getOSGiServiceIdentifier in interface ServiceWrapper<UserGroupService>

Specified by:

getOSGiServiceIdentifier in interface UserGroupService

Returns:

the OSGi service identifier

getUserGroup

public UserGroup getUserGroup(long userGroupId)
                       throws PortalException

Returns the user group with the primary key.

Specified by:

getUserGroup in interface UserGroupService

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

PortalException

getUserGroup

public UserGroup getUserGroup(String name)
                       throws PortalException

Returns the user group with the name.

Specified by:

getUserGroup in interface UserGroupService

Parameters:

name - the user group's name

Returns:

the user group with the name

Throws:

PortalException

getUserGroupByExternalReferenceCode

public UserGroup getUserGroupByExternalReferenceCode(String externalReferenceCode,
 long companyId)
                                              throws PortalException

Specified by:

getUserGroupByExternalReferenceCode in interface UserGroupService

Throws:

PortalException

getUserGroups

public List<UserGroup> getUserGroups(long companyId)
                              throws PortalException

Specified by:

getUserGroups in interface UserGroupService

Throws:

PortalException

getUserGroups

public List<UserGroup> getUserGroups(long companyId,
 String name,
 int start,
 int end)

Specified by:

getUserGroups in interface UserGroupService

getUserGroupsCount

public int getUserGroupsCount(long companyId,
 String name)

Specified by:

getUserGroupsCount in interface UserGroupService

getUserUserGroups

public List<UserGroup> getUserUserGroups(long userId)
                                  throws PortalException

Returns all the user groups to which the user belongs.

Specified by:

getUserUserGroups in interface UserGroupService

Parameters:

userId - the primary key of the user

Returns:

the user groups to which the user belongs

Throws:

PortalException

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 and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to

invalid reference

QueryUtil#ALL_POS

will return the full result set.

Specified by:

search in interface UserGroupService

Parameters:

companyId - the primary key of the user group's company

keywords - the keywords (space separated), which may occur in the user group's name or description (optionally null)

params - the finder params (optionally null). For more information see UserGroupFinder

start - the lower bound of the range of user groups to return

end - the upper bound of the range of user groups to return (not inclusive)

orderByComparator - the comparator to order the user groups (optionally null)

Returns:

the matching user groups ordered by comparator orderByComparator

See Also:

• UserGroupFinder

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 and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to

invalid reference

QueryUtil#ALL_POS

will return the full result set.

Specified by:

search in interface UserGroupService

Parameters:

companyId - the primary key of the user group's company

name - the user group's name (optionally null)

description - the user group's description (optionally null)

params - the finder params (optionally null). For more information see UserGroupFinder

andOperator - whether every field must match its keywords or just one field

start - the lower bound of the range of user groups to return

end - the upper bound of the range of user groups to return (not inclusive)

orderByComparator - the comparator to order the user groups (optionally null)

Returns:

the matching user groups ordered by comparator orderByComparator

See Also:

• UserGroupFinder

searchCount

public int searchCount(long companyId,
 String keywords,
 LinkedHashMap<String,Object> params)

Returns the number of user groups that match the keywords

Specified by:

searchCount in interface UserGroupService

Parameters:

companyId - the primary key of the user group's company

keywords - the keywords (space separated), which may occur in the user group's name or description (optionally null)

params - the finder params (optionally null). For more information see UserGroupFinder

Returns:

the number of matching user groups

See Also:

• UserGroupFinder

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 interface UserGroupService

Parameters:

companyId - the primary key of the user group's company

name - the user group's name (optionally null)

description - the user group's description (optionally null)

params - the finder params (optionally null). For more information see UserGroupFinder

andOperator - whether every field must match its keywords or just one field

Returns:

the number of matching user groups

See Also:

• UserGroupFinder

unsetGroupUserGroups

public void unsetGroupUserGroups(long groupId,
 long[] userGroupIds)
                          throws PortalException

Removes the user groups from the group.

Specified by:

unsetGroupUserGroups in interface UserGroupService

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

PortalException

unsetTeamUserGroups

public void unsetTeamUserGroups(long teamId,
 long[] userGroupIds)
                         throws PortalException

Removes the user groups from the team.

Specified by:

unsetTeamUserGroups in interface UserGroupService

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

PortalException

updateExternalReferenceCode

public UserGroup updateExternalReferenceCode(UserGroup userGroup,
 String externalReferenceCode)
                                      throws PortalException

Specified by:

updateExternalReferenceCode in interface UserGroupService

Throws:

PortalException

updateUserGroup

public UserGroup updateUserGroup(String externalReferenceCode,
 long userGroupId,
 String name,
 String description,
 ServiceContext serviceContext)
                          throws PortalException

Updates the user group.

Specified by:

updateUserGroup in interface UserGroupService

Parameters:

externalReferenceCode - the user group's external reference code

userGroupId - the primary key of the user group

name - the user group's name

description - the the user group's description

serviceContext - the service context to be applied (optionally null). Can set expando bridge attributes for the user group.

Returns:

the user group

Throws:

PortalException

getWrappedService

public UserGroupService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<UserGroupService>

setWrappedService

public void setWrappedService(UserGroupService userGroupService)

Specified by:

setWrappedService in interface ServiceWrapper<UserGroupService>