Liferay 7.0-ce-b4

com.liferay.portal.service.impl
Class UserGroupServiceImpl

java.lang.Object
  extended by com.liferay.portal.service.BaseServiceImpl
      extended by com.liferay.portal.service.base.UserGroupServiceBaseImpl
          extended by com.liferay.portal.service.impl.UserGroupServiceImpl
All Implemented Interfaces:
IdentifiableOSGiService, BaseService, UserGroupService

public class UserGroupServiceImpl
extends UserGroupServiceBaseImpl

Provides the remote service for accessing, adding, deleting, and updating user groups. Its methods include permission checks.


Field Summary
 
Fields inherited from class com.liferay.portal.service.base.UserGroupServiceBaseImpl
counterLocalService, expandoRowLocalService, expandoRowPersistence, exportImportConfigurationLocalService, exportImportConfigurationPersistence, exportImportConfigurationService, exportImportLocalService, exportImportService, groupFinder, groupLocalService, groupPersistence, groupService, layoutFinder, layoutLocalService, layoutPersistence, layoutService, resourceLocalService, teamFinder, teamLocalService, teamPersistence, teamService, userFinder, userGroupFinder, userGroupGroupRoleFinder, userGroupGroupRoleLocalService, userGroupGroupRolePersistence, userGroupGroupRoleService, userGroupLocalService, userGroupPersistence, userGroupService, userLocalService, userPersistence, userService
 
Fields inherited from class com.liferay.portal.service.BaseServiceImpl
ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS
 
Constructor Summary
UserGroupServiceImpl()
           
 
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.
protected  List<UserGroup> filterUserGroups(List<UserGroup> userGroups)
           
 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.
 
Methods inherited from class com.liferay.portal.service.base.UserGroupServiceBaseImpl
afterPropertiesSet, destroy, getCounterLocalService, getExpandoRowLocalService, getExpandoRowPersistence, getExportImportConfigurationLocalService, getExportImportConfigurationPersistence, getExportImportConfigurationService, getExportImportLocalService, getExportImportService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getLayoutFinder, getLayoutLocalService, getLayoutPersistence, getLayoutService, getModelClass, getModelClassName, getOSGiServiceIdentifier, getResourceLocalService, getTeamFinder, getTeamLocalService, getTeamPersistence, getTeamService, getUserFinder, getUserGroupFinder, getUserGroupGroupRoleFinder, getUserGroupGroupRoleLocalService, getUserGroupGroupRolePersistence, getUserGroupGroupRoleService, getUserGroupLocalService, getUserGroupPersistence, getUserGroupService, getUserLocalService, getUserPersistence, getUserService, runSQL, setCounterLocalService, setExpandoRowLocalService, setExpandoRowPersistence, setExportImportConfigurationLocalService, setExportImportConfigurationPersistence, setExportImportConfigurationService, setExportImportLocalService, setExportImportService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setLayoutFinder, setLayoutLocalService, setLayoutPersistence, setLayoutService, setResourceLocalService, setTeamFinder, setTeamLocalService, setTeamPersistence, setTeamService, setUserFinder, setUserGroupFinder, setUserGroupGroupRoleFinder, setUserGroupGroupRoleLocalService, setUserGroupGroupRolePersistence, setUserGroupGroupRoleService, setUserGroupLocalService, setUserGroupPersistence, setUserGroupService, setUserLocalService, setUserPersistence, setUserService
 
Methods inherited from class com.liferay.portal.service.BaseServiceImpl
getClassLoader, getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupServiceImpl

public UserGroupServiceImpl()
Method Detail

addGroupUserGroups

public 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 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 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

public 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 void deleteUserGroup(long userGroupId)
                     throws PortalException
Deletes the user group.

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.

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

getUserGroup

public 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 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 List<UserGroup> getUserGroups(long companyId)
                              throws PortalException
Throws:
PortalException

getUserUserGroups

public 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 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 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 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

public 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

filterUserGroups

protected List<UserGroup> filterUserGroups(List<UserGroup> userGroups)
                                    throws PortalException
Throws:
PortalException

Liferay 7.0-ce-b4