com.liferay.portal.kernel.service

Class UserGroupServiceUtil

Object

com.liferay.portal.kernel.service.UserGroupServiceUtil

@ProviderType
public class UserGroupServiceUtil
extends Object

Provides the remote service utility for UserGroup. This utility wraps UserGroupServiceImpl and is the primary access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

UserGroupService, UserGroupServiceBaseImpl, UserGroupServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
UserGroupServiceUtil()

Method Summary

Modifier and Type	Method and Description
static void	addGroupUserGroups(long groupId, long[] userGroupIds) Adds the user groups to the group.
static void	addTeamUserGroups(long teamId, long[] userGroupIds) Adds the user groups to the team
static UserGroup	addUserGroup(String name, String description) Deprecated. As of Newton (6.2.x), replaced by addUserGroup(String, String, ServiceContext)
static UserGroup	addUserGroup(String name, String description, ServiceContext serviceContext) Adds a user group.
static void	deleteUserGroup(long userGroupId) Deletes the user group.
static UserGroup	fetchUserGroup(long userGroupId) Fetches the user group with the primary key.
static List<UserGroup>	getGtUserGroups(long gtUserGroupId, long companyId, long parentUserGroupId, int size)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static UserGroupService	getService()
static UserGroup	getUserGroup(long userGroupId) Returns the user group with the primary key.
static UserGroup	getUserGroup(String name) Returns the user group with the name.
static List<UserGroup>	getUserGroups(long companyId)
static List<UserGroup>	getUserGroups(long companyId, String name, int start, int end)
static int	getUserGroupsCount(long companyId, String name)
static List<UserGroup>	getUserUserGroups(long userId) Returns all the user groups to which the user belongs.
static void	unsetGroupUserGroups(long groupId, long[] userGroupIds) Removes the user groups from the group.
static void	unsetTeamUserGroups(long teamId, long[] userGroupIds) Removes the user groups from the team.
static UserGroup	updateUserGroup(long userGroupId, String name, String description) Deprecated. As of Newton (6.2.x), replaced by updateUserGroup(long, String, String, ServiceContext)
static UserGroup	updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) Updates the user group.

Methods inherited from class Object

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

Constructor Detail

UserGroupServiceUtil

public UserGroupServiceUtil()

Method Detail

addGroupUserGroups

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

Adds the user groups to the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

PortalException

addTeamUserGroups

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

Adds the user groups to the team

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

PortalException

addUserGroup

@Deprecated
public static UserGroup addUserGroup(String name,
                                                 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.

Parameters:

name - the user group's name

description - the user group's description

Returns:

the user group

Throws:

PortalException

addUserGroup

public static UserGroup addUserGroup(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.

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 static void deleteUserGroup(long userGroupId)
                            throws PortalException

Deletes the user group.

Parameters:

userGroupId - the primary key of the user group

Throws:

PortalException

fetchUserGroup

public static UserGroup fetchUserGroup(long userGroupId)
                                throws PortalException

Fetches the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

PortalException

getGtUserGroups

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

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getUserGroup

public static UserGroup getUserGroup(long userGroupId)
                              throws PortalException

Returns the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

the user group with the primary key

Throws:

PortalException

getUserGroup

public static UserGroup getUserGroup(String name)
                              throws PortalException

Returns the user group with the name.

Parameters:

name - the user group's name

Returns:

the user group with the name

Throws:

PortalException

getUserGroups

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

Throws:

PortalException

getUserGroups

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

getUserGroupsCount

public static int getUserGroupsCount(long companyId,
                                     String name)

getUserUserGroups

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

Returns all the user groups to which the user belongs.

Parameters:

userId - the primary key of the user

Returns:

the user groups to which the user belongs

Throws:

PortalException

unsetGroupUserGroups

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

Removes the user groups from the group.

Parameters:

groupId - the primary key of the group

userGroupIds - the primary keys of the user groups

Throws:

PortalException

unsetTeamUserGroups

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

Removes the user groups from the team.

Parameters:

teamId - the primary key of the team

userGroupIds - the primary keys of the user groups

Throws:

PortalException

updateUserGroup

@Deprecated
public static UserGroup updateUserGroup(long userGroupId,
                                                    String name,
                                                    String description)
                                             throws PortalException

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

Updates the user group.

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 static UserGroup updateUserGroup(long userGroupId,
                                        String name,
                                        String description,
                                        ServiceContext serviceContext)
                                 throws PortalException

Updates the user group.

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

getService

public static UserGroupService getService()