com.liferay.portal.service
Class UserGroupServiceUtil

java.lang.Object
  com.liferay.portal.service.UserGroupServiceUtil

public class UserGroupServiceUtil
extends Object

The utility for the user group remote service. This utility wraps UserGroupServiceImpl and is the primary access point for service operations in application layer code running on a remote server.

This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

UserGroupService, UserGroupServiceBaseImpl, UserGroupServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

UserGroupServiceUtil()

Method Summary

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) Adds a user group.
static void	deleteUserGroup(long userGroupId) Deletes the user group.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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>	getUserUserGroups(long userId) Returns all the user groups to which the user belongs.
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(UserGroupService service) Deprecated.
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) Updates the user group.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserGroupServiceUtil

public UserGroupServiceUtil()

Method Detail

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addGroupUserGroups

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

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 - if a group or user group with the primary key could not be found, or if the user did not have permission to assign group members

SystemException - if a system exception occurred

addTeamUserGroups

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

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 - if a team or user group with the primary key could not be found, or if the user did not have permission to assign team members

SystemException - if a system exception occurred

addUserGroup

public static UserGroup addUserGroup(String name,
                                     String description)
                              throws PortalException,
                                     SystemException

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 - if the user group's information was invalid or if the user did not have permission to add the user group

SystemException - if a system exception occurred

deleteUserGroup

public static void deleteUserGroup(long userGroupId)
                            throws PortalException,
                                   SystemException

Deletes the user group.

Parameters:

userGroupId - the primary key of the user group

Throws:

PortalException - if a user group with the primary key could not be found, if the user did not have permission to delete the user group, or if the user group had a workflow in approved status

SystemException - if a system exception occurred

getUserGroup

public static UserGroup getUserGroup(long userGroupId)
                              throws PortalException,
                                     SystemException

Returns the user group with the primary key.

Parameters:

userGroupId - the primary key of the user group

Returns:

Returns the user group with the primary key

Throws:

PortalException - if a user group with the primary key could not be found or if the user did not have permission to view the user group

SystemException - if a system exception occurred

getUserGroup

public static UserGroup getUserGroup(String name)
                              throws PortalException,
                                     SystemException

Returns the user group with the name.

Parameters:

name - the user group's name

Returns:

Returns the user group with the name

Throws:

PortalException - if a user group with the name could not be found or if the user did not have permission to view the user group

SystemException - if a system exception occurred

getUserUserGroups

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

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 - if the current user did not have permission to view the user or any one of the user group members

SystemException - if a system exception occurred

unsetGroupUserGroups

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

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 - if the user did not have permission to assign group members

SystemException - if a system exception occurred

unsetTeamUserGroups

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

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 - if the user did not have permission to assign team members

SystemException - if a system exception occurred

updateUserGroup

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

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 - if a user group with the primary key was not found, if the new information was invalid, or if the user did not have permission to update the user group information

SystemException - if a system exception occurred

getService

public static UserGroupService getService()

setService

public void setService(UserGroupService service)

Deprecated.