Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class UserGroupServiceWrapper

java.lang.Object
  extended by com.liferay.portal.service.UserGroupServiceWrapper
All Implemented Interfaces:
BaseService, ServiceWrapper<UserGroupService>, UserGroupService

public class UserGroupServiceWrapper
extends Object
implements UserGroupService, ServiceWrapper<UserGroupService>

This class is a wrapper for UserGroupService.

See Also:
UserGroupService
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
UserGroupServiceWrapper(UserGroupService userGroupService)
           
 
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)
          Adds a user group.
 void deleteUserGroup(long userGroupId)
          Deletes the user group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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> getUserUserGroups(long userId)
          Returns all the user groups to which the user belongs.
 UserGroupService getWrappedService()
           
 UserGroupService getWrappedUserGroupService()
          Deprecated. Renamed to getWrappedService()
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setWrappedService(UserGroupService userGroupService)
           
 void setWrappedUserGroupService(UserGroupService userGroupService)
          Deprecated. Renamed to setWrappedService(com.liferay.portal.service.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, 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

UserGroupServiceWrapper

public UserGroupServiceWrapper(UserGroupService userGroupService)
Method Detail

getBeanIdentifier

public String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Specified by:
getBeanIdentifier in interface UserGroupService
Returns:
the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Specified by:
setBeanIdentifier in interface UserGroupService
Parameters:
beanIdentifier - the Spring bean ID for this bean

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               long[] userGroupIds)
                        throws PortalException,
                               SystemException
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 - 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 void addTeamUserGroups(long teamId,
                              long[] userGroupIds)
                       throws PortalException,
                              SystemException
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 - 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 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.

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

Specified by:
deleteUserGroup in interface UserGroupService
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 UserGroup getUserGroup(long userGroupId)
                       throws PortalException,
                              SystemException
Returns the user group with the primary key.

Specified by:
getUserGroup in interface UserGroupService
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 UserGroup getUserGroup(String name)
                       throws PortalException,
                              SystemException
Returns the user group with the name.

Specified by:
getUserGroup in interface UserGroupService
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 List<UserGroup> getUserUserGroups(long userId)
                                  throws PortalException,
                                         SystemException
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 - 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 void unsetGroupUserGroups(long groupId,
                                 long[] userGroupIds)
                          throws PortalException,
                                 SystemException
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 - if the user did not have permission to assign group members
SystemException - if a system exception occurred

unsetTeamUserGroups

public void unsetTeamUserGroups(long teamId,
                                long[] userGroupIds)
                         throws PortalException,
                                SystemException
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 - if the user did not have permission to assign team members
SystemException - if a system exception occurred

updateUserGroup

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

getWrappedUserGroupService

public UserGroupService getWrappedUserGroupService()
Deprecated. Renamed to getWrappedService()


setWrappedUserGroupService

public void setWrappedUserGroupService(UserGroupService userGroupService)
Deprecated. Renamed to setWrappedService(com.liferay.portal.service.UserGroupService)


getWrappedService

public UserGroupService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<UserGroupService>

setWrappedService

public void setWrappedService(UserGroupService userGroupService)
Specified by:
setWrappedService in interface ServiceWrapper<UserGroupService>

Liferay 6.1.2-ce-ga3