Liferay 7.0-ce-b4

com.liferay.portal.service
Interface UserGroupService

All Superinterfaces:
BaseService
All Known Implementing Classes:
UserGroupServiceBaseImpl, UserGroupServiceImpl, UserGroupServiceWrapper

@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupService
extends BaseService

Provides the remote service interface for UserGroup. 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:
UserGroupServiceUtil, UserGroupServiceBaseImpl, UserGroupServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 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(String name, String description)
          Deprecated. As of 6.2.0, replaced by addUserGroup(String, String, ServiceContext)
 UserGroup addUserGroup(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.
 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.
 List<UserGroup> getUserGroups(long companyId)
           
 List<UserGroup> getUserUserGroups(long userId)
          Returns all the user groups to which the user belongs.
 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, String name, String description)
          Deprecated. As of 6.2.0, replaced by updateUserGroup(long, String, String, ServiceContext)
 UserGroup updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext)
          Updates the user group.
 

Method Detail

addGroupUserGroups

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

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
UserGroup addUserGroup(String name,
                                  String description)
                       throws PortalException
Deprecated. As of 6.2.0, 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

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

void deleteUserGroup(long userGroupId)
                     throws PortalException
Deletes the user group.

Parameters:
userGroupId - the primary key of the user group
Throws:
PortalException

fetchUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long companyId)
                              throws PortalException
Throws:
PortalException

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

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
UserGroup updateUserGroup(long userGroupId,
                                     String name,
                                     String description)
                          throws PortalException
Deprecated. As of 6.2.0, 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

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

Liferay 7.0-ce-b4