CollaborationGroupWrapper (Sitevision API)

All Superinterfaces:

Wrapper<Node>
```
public interface CollaborationGroupWrapper
extends Wrapper<Node>
```
Collaboration group administration interface.
This wrapper provides methods to update an existing collaboration group. You would typically use CollaborationGroupUtil to create a new collaboration group.

An instance of the Sitevision class implementing this interface can be obtained via CollaborationFactory.getCollaborationGroupWrapper(javax.jcr.Node). See CollaborationFactory for how to obtain an instance of the CollaborationFactory interface.

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addAdmin(Node aUserIdentity)` Adds a user identity as admin of the wrapped collaboration group.
`boolean`	`addMember(Node aUserIdentity)` Adds a user identity as member of the wrapped collaboration group.
`Set<Node>`	`getAdmins()` Gets the admins of the wrapped collaboration group.
`Node`	`getCollaborationGroup()` Gets the wrapped collaboration group.
`Set<Node>`	`getFollowers()` Gets the followers/eavesdroppers of the wrapped collaboration group.
`String`	`getGroupDescription()` Gets the group description of the wrapped collaboration group.
`CollaborationGroupState`	`getGroupState()` Gets the collaboration group state of the wrapped collaboration group.
`CollaborationGroupType`	`getGroupType()` Gets the collaboration group type of the wrapped collaboration group.
`Set<Node>`	`getMembers()` Gets the members of the wrapped collaboration group.
`Node`	`getProfileImage()` Gets the profile image of the wrapped collaboration group.
`Node`	`getProfileImagesFolder()` Gets the profile images folder of the wrapped collaboration group.
`boolean`	`isAdmin(Node aUserIdentity)` Checks if a user identity is admin of the wrapped collaboration group.
`boolean`	`isFollower(Node aUserIdentity)` Checks if a user identity is a follower/eavesdropper of the wrapped collaboration group.
`boolean`	`isMember(Node aUserIdentity)` Checks if a user identity is member of the wrapped collaboration group.
`boolean`	`removeMember(Node aUserIdentity)` Removes a member from the wrapped collaboration group.
`boolean`	`renameGroup(String aGroupName)` Alters the name of the wrapped collaboration group.
`void`	`setGroupDescription(String aGroupDescription)` Sets the group description of the wrapped collaboration group.
`void`	`setGroupState(CollaborationGroupState aCollaborationGroupState)` Changes the collaboration group state of the wrapped collaboration group.
`void`	`setGroupType(CollaborationGroupType aCollaborationGroupType)` Changes the collaboration group type of the wrapped collaboration group.
`boolean`	`setLocale(Locale aLocale)` Alters the render Locale used by the wrapped collaboration group.
`boolean`	`setProfileImage(Node aProfileImage)` Sets the profile image of the wrapped collaboration group.

Methods inherited from interface senselogic.sitevision.api.base.Wrapper
unwrap

- Method Detail
  - getAdmins
```
Set<Node> getAdmins()
```
    Gets the admins of the wrapped collaboration group.
    
    Returns:
    
    the admins of the wrapped collaboration group. Never null.
  - isAdmin
```
boolean isAdmin(Node aUserIdentity)
```
    Checks if a user identity is admin of the wrapped collaboration group.
    
    Parameters:
    
    aUserIdentity - a user identity (or user)
    
    Returns:
    
    true if aUserIdentity is admin of the wrapped group, false otherwise
  - addAdmin
```
boolean addAdmin(Node aUserIdentity)
```
    Adds a user identity as admin of the wrapped collaboration group.
    Only non-admins will be added, i.e. a user identity that already is an admin will be ignored. Collaboration groups that are inactive/unavailable don't accept any new admins.
    
    Permission note! To add an admin to the wrapped group, current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the group.
    
    Parameters:
    
    aUserIdentity - a user identity (or user)
    
    Returns:
    
    true if aUserIdentity was added as admin of the wrapped group, false otherwise. false is always returned if aUserIdentity is null or already is admin of the wrapped collaboration group.
    
    Since:
    
    Sitevision 4.5.4
  - getMembers
```
Set<Node> getMembers()
```
    Gets the members of the wrapped collaboration group.
    Note! Admins are also considered as members.
    
    Returns:
    
    the members of the wrapped collaboration group. Never null.
  - isMember
```
boolean isMember(Node aUserIdentity)
```
    Checks if a user identity is member of the wrapped collaboration group.
    
    Parameters:
    
    aUserIdentity - a user identity (or user)
    
    Returns:
    
    true if aUserIdentity is member of the wrapped group, false otherwise
  - addMember
```
boolean addMember(Node aUserIdentity)
```
    Adds a user identity as member of the wrapped collaboration group.
    Only non-members will be added, i.e. a user identity that already is a member will be ignored. Collaboration groups that are inactive doesn't accept any new members.
    
    Permission note! To add a member to the wrapped group, current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the group - or current user must match the given user identity (i.e. "is yourself") and have PermissionUtil.Permission.READ on the wrapped group.
    
    Parameters:
    
    aUserIdentity - a user identity (or user)
    
    Returns:
    
    true if aUserIdentity was added as member of the wrapped group, false otherwise. false is always returned if aUserIdentity is null or already are a member (or admin) of the wrapped collaboration group.
  - removeMember
```
boolean removeMember(Node aUserIdentity)
```
    Removes a member from the wrapped collaboration group.
    Only members can be removed, i.e. a user identity that is a non-member will be ignored. Note that an admin is also a member so removing a member might in fact also remove an admin, but last admin will never be removed. Members can not be removed from collaboration groups that are inactive.
    
    Permission note! To remove group membership for a user identity, current user must match the user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP and PermissionUtil.Permission.READ on the wrapped group.
    
    Parameters:
    
    aUserIdentity - a user identity (or user)
    
    Returns:
    
    true if aUserIdentity was removed as member from the wrapped group, false otherwise. false is always returned if aUserIdentity is null or not a member (or admin) or last admin of the wrapped collaboration group.
  - getFollowers
```
Set<Node> getFollowers()
```
    Gets the followers/eavesdroppers of the wrapped collaboration group.
    
    Returns:
    
    the followers of the wrapped collaboration group. Never null.
    
    Since:
    
    Sitevision 4.1
  - isFollower
```
boolean isFollower(Node aUserIdentity)
```
    Checks if a user identity is a follower/eavesdropper of the wrapped collaboration group.
    
    Parameters:
    
    aUserIdentity - a user identity (or user)
    
    Returns:
    
    true if aUserIdentity is a follower of the wrapped group, false otherwise
    
    Since:
    
    Sitevision 4.1
  - renameGroup
```
boolean renameGroup(String aGroupName)
```
    Alters the name of the wrapped collaboration group.
    Permission note! Current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the wrapped collaboration group.
    
    Name note! Each group name must be (case-insensitively) unique in a given structure (i.e. collaboration group folder). This method will remove leading and trailing whitespace from aGroupName and use the remaining characters as new name. The wrapped group will not be renamed if aGroupName is null, whitespace only or if the remaining characters already exist as group name.
    
    Tip! Use CollaborationGroupFolderUtil.containsCollaborationGroup(javax.jcr.Node, String) to check if a named collaboration group already exists in the collaboration group folder of the group.
    
    Parameters:
    
    aGroupName - the new group name
    
    Returns:
    
    true if group could be renamed to aGroupName, false otherwise.
    
    Since:
    
    Sitevision 3.6.4
  - getGroupType
```
CollaborationGroupType getGroupType()
```
    Gets the collaboration group type of the wrapped collaboration group.
    
    Returns:
    
    the collaboration group type
    
    Since:
    
    Sitevision 4.1
  - setGroupType
```
void setGroupType(CollaborationGroupType aCollaborationGroupType)
```
    Changes the collaboration group type of the wrapped collaboration group.
    The group type can not be changed for collaboration groups that are inactive.
    
    Permission note! Current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the wrapped collaboration group in order to change group type. In order to change group type to CollaborationGroupType.CLOSED, current user must also have PermissionUtil.Permission.CREATE_CLOSED_COLLABORATION_GROUP on the wrapped collaboration group.
    
    Note! Setting a group to CLOSED will break any potential permission inheritance for the group page of the group. Hence the user that sets the group to CollaborationGroupType.CLOSED can potentially lose its permissions to access the (now closed) group!
    
    Parameters:
    
    aCollaborationGroupType - the collaboration group type
    
    Since:
    
    Sitevision 4.1
  - getGroupState
```
CollaborationGroupState getGroupState()
```
    Gets the collaboration group state of the wrapped collaboration group.
    
    Returns:
    
    the collaboration group state
    
    Since:
    
    Sitevision 4.1
  - setGroupState
```
void setGroupState(CollaborationGroupState aCollaborationGroupState)
```
    Changes the collaboration group state of the wrapped collaboration group.
    Permission note! Current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the wrapped collaboration group in order to change group state.
    
    Parameters:
    
    aCollaborationGroupState - the collaboration group state
    
    Since:
    
    Sitevision 4.1
  - getGroupDescription
```
String getGroupDescription()
```
    Gets the group description of the wrapped collaboration group.
    
    Returns:
    
    the collaboration group description
    
    Since:
    
    Sitevision 4.5.3
  - setGroupDescription
```
void setGroupDescription(String aGroupDescription)
```
    Sets the group description of the wrapped collaboration group.
    Permission note! Current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the wrapped collaboration group in order to change group description.
    
    Parameters:
    
    aGroupDescription - the collaboration group description
    
    Since:
    
    Sitevision 4.5.3
  - getProfileImagesFolder
```
Node getProfileImagesFolder()
```
    Gets the profile images folder of the wrapped collaboration group.
    
    Returns:
    
    the profile images folder or null
    
    Since:
    
    Sitevision 4.5.3
  - getProfileImage
```
Node getProfileImage()
```
    Gets the profile image of the wrapped collaboration group.
    Note! This method returns the 'raw' profile image (i.e. a Node of type sv:image) that the group has uploaded. For buddy icons, see BuddyIconRenderer.
    
    Returns:
    
    the profile image or null
    
    Since:
    
    Sitevision 4.5.3
  - setProfileImage
```
boolean setProfileImage(Node aProfileImage)
```
    Sets the profile image of the wrapped collaboration group.
    This method sets the active profile image, i.e. determines which profile image that should be used. To create a new profile image (i.e. new binary data), you would typically use a method in ImageUtil first.
    
    Model note! A profile image must be a Node of type sv:image and a child of the profile images folder of the wrapped collaboration group. The profile images folder is available via getProfileImagesFolder().
    
    Permission note! Current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the wrapped collaboration group in order to set the profile image.
    
    Parameters:
    
    aProfileImage - the profile image
    
    Returns:
    
    true if the set operation succeeded, false otherwise
    
    Since:
    
    Sitevision 4.5.3
  - setLocale
```
boolean setLocale(Locale aLocale)
```
    Alters the render Locale used by the wrapped collaboration group.
    Permission note! Current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the wrapped collaboration group.
    
    Note! This method sets the Locale on the sv:collaborationGroupPage where the wrapped collaboration group resides. Mutation of Locale will fail if the collaboration group page is locked.
    
    Parameters:
    
    aLocale - the Locale, must be a supported/available Locale (as of LocaleUtil.getAvailableLocales())
    
    Returns:
    
    true if the set operation succeeded, false otherwise
    
    Since:
    
    Sitevision 6.1
  - getCollaborationGroup
```
Node getCollaborationGroup()
```
    Gets the wrapped collaboration group.
    Note! This method is equivalent with Wrapper.unwrap() if this wrapper is created with a sv:collaborationGroup Node.
    
    Returns:
    
    the wrapped collaboration group
    
    Since:
    
    Sitevision 4.3

Sitevision - Content Management Made Easy
Sitevision is an advanced Java enterprise portal product that implements Java Content Repository (JSR 283).

Interface CollaborationGroupWrapper

Method Summary

Methods inherited from interface senselogic.sitevision.api.base.Wrapper

Method Detail

getAdmins

isAdmin

addAdmin

getMembers

isMember

addMember

removeMember

getFollowers

isFollower

renameGroup

getGroupType

setGroupType

getGroupState

setGroupState

getGroupDescription

setGroupDescription

getProfileImagesFolder

getProfileImage

setProfileImage

setLocale

getCollaborationGroup