com.liferay.portal.kernel.service

Class UserGroupServiceWrapper

java.lang.Object

com.liferay.portal.kernel.service.UserGroupServiceWrapper

All Implemented Interfaces:

BaseService, ServiceWrapper<UserGroupService>, UserGroupService

@ProviderType
public class UserGroupServiceWrapper
extends java.lang.Object
implements UserGroupService, ServiceWrapper<UserGroupService>

Provides a wrapper for UserGroupService.

Author:

Brian Wing Shun Chan

See Also:

UserGroupService

Generated:

Constructor Summary

Constructors

Constructor and Description
UserGroupServiceWrapper(UserGroupService userGroupService)

Method Summary

Modifier and Type	Method and Description
void	addGroupUserGroups(long groupId, long[] userGroupIds) Adds the user groups to the group.
void	addTeamUserGroups(long teamId, long[] userGroupIds) Adds the user groups to the team
UserGroup	addUserGroup(java.lang.String name, java.lang.String description) Deprecated. As of Newton (6.2.x), replaced by addUserGroup(String, String, ServiceContext)
UserGroup	addUserGroup(java.lang.String name, java.lang.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.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
UserGroup	getUserGroup(long userGroupId) Returns the user group with the primary key.
UserGroup	getUserGroup(java.lang.String name) Returns the user group with the name.
java.util.List<UserGroup>	getUserGroups(long companyId)
java.util.List<UserGroup>	getUserUserGroups(long userId) Returns all the user groups to which the user belongs.
UserGroupService	getWrappedService()
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	updateUserGroup(long userGroupId, java.lang.String name, java.lang.String description) Deprecated. As of Newton (6.2.x), replaced by updateUserGroup(long, String, String, ServiceContext)
UserGroup	updateUserGroup(long userGroupId, java.lang.String name, java.lang.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 Detail

UserGroupServiceWrapper

public UserGroupServiceWrapper(UserGroupService userGroupService)

Method Detail

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

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

@Deprecated
public UserGroup addUserGroup(java.lang.String name,
                                          java.lang.String description)
                                   throws PortalException

Deprecated. As of Newton (6.2.x), replaced by addUserGroup(String, String, ServiceContext)

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:

name - the user group's name

description - the user group's description

Returns:

the user group

Throws:

PortalException

addUserGroup

public UserGroup addUserGroup(java.lang.String name,
                              java.lang.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:

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

getOSGiServiceIdentifier

public java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

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(java.lang.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

getUserGroups

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

Specified by:

getUserGroups in interface UserGroupService

Throws:

PortalException

getUserUserGroups

public java.util.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

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

updateUserGroup

@Deprecated
public UserGroup updateUserGroup(long userGroupId,
                                             java.lang.String name,
                                             java.lang.String description)
                                      throws PortalException

Deprecated. As of Newton (6.2.x), replaced by updateUserGroup(long, String, String, ServiceContext)

Updates the user group.

Specified by:

updateUserGroup in interface UserGroupService

Parameters:

userGroupId - the primary key of the user group

name - the user group's name

description - the the user group's description

Returns:

the user group

Throws:

PortalException

updateUserGroup

public UserGroup updateUserGroup(long userGroupId,
                                 java.lang.String name,
                                 java.lang.String description,
                                 ServiceContext serviceContext)
                          throws PortalException

Updates the user group.

Specified by:

updateUserGroup in interface UserGroupService

Parameters:

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>