senselogic.sitevision.api.collaboration

Interface CollaborationGroupUtil

@Requireable(value="CollaborationGroupUtil")
public interface CollaborationGroupUtil

Collaboration group utility interface.

Note! This interface is used to create collaboration groups. You would typically use CollaborationGroupWrapper to update an existing collaboration group.

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

Since:

Sitevision 3.6.4

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
Node	createCollaborationGroup(Node aGroupTemplate, Node aGroupFolder, String aGroupName) Creates an open collaboration group.
Node	createCollaborationGroup(Node aGroupTemplate, Node aGroupFolder, String aGroupName, CollaborationGroupType aGroupType) Creates a collaboration group.
boolean	removeCollaborationGroup(Node aCollaborationGroup) Removes a collaboration group.

Method Detail

createCollaborationGroup

Node createCollaborationGroup(Node aGroupTemplate,
                              Node aGroupFolder,
                              String aGroupName)
                       throws ConstraintViolationException,
                              RepositoryException

Creates an open collaboration group.

This is a legacy convenience method that delegates to createCollaborationGroup(Node, Node, String, CollaborationGroupType) using CollaborationGroupType.OPEN as group type.

Parameters:

aGroupTemplate - the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group

aGroupFolder - the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside

aGroupName - the name of the collaboration group

Returns:

The created collaboration group (sv:collaborationGroup)

Throws:

NullPointerException - if aGroupTemplate, aGroupFolder or aGroupName is null

ConstraintViolationException - if aGroupTemplate or aGroupFolder is of invalid type, if aGroupName is whitespace only, if aGroupFolder already contains a collaboration group named aGroupName (case ignored) or if current user is not authorized to create the collaboration group

RepositoryException - if something else goes wrong

See Also:

createCollaborationGroup(Node, Node, String, CollaborationGroupType)

createCollaborationGroup

Node createCollaborationGroup(Node aGroupTemplate,
                              Node aGroupFolder,
                              String aGroupName,
                              CollaborationGroupType aGroupType)
                       throws RepositoryException

Creates a collaboration group.

Permission note! Current user must have PermissionUtil.Permission.READ on aGroupTemplate and PermissionUtil.Permission.CREATE_COLLABORATION_GROUP on aGroupFolder. In order to create a CollaborationGroupType.CLOSED collaboration group, current user must also have PermissionUtil.Permission.CREATE_CLOSED_COLLABORATION_GROUP on aGroupFolder.

User note! Current user must have a user identity as it will be the administrator of the created group. Anonymous users doesn't have a user identity, nor the Indexer, Validator or the Extractor. In other words: PortletContextUtil.getCurrentUserIdentity() must be non-null.

Tip! Use CollaborationGroupTemplateUtil to get a group template, use CollaborationGroupFolderUtil to get the default group folder (and perhaps check if the collaboration folder already contains a collaboration group with specified name). Use CollaborationGroupWrapper to update the group that is created.

Parameters:

aGroupTemplate - the collaboration group template (sv:collaborationGroupTemplate) to use when creating the collaboration group page of the collaboration group

aGroupFolder - the collaboration group folder (sv:collaborationGroupFolder) where the collaboration group page of the collaboration group should reside

aGroupName - the name of the collaboration group

aGroupType - the group type, note that CollaborationGroupType.CLOSED needs additional permission

Returns:

The created collaboration group (sv:collaborationGroup)

Throws:

NullPointerException - if aGroupTemplate, aGroupFolder, aGroupName or aGroupType is null

ConstraintViolationException - if aGroupTemplate or aGroupFolder is of invalid type, if aGroupName is whitespace only, if aGroupFolder already contains a collaboration group named aGroupName (case ignored) or if current user is not authorized to create the collaboration group (see permission note above)

RepositoryException - if something else goes wrong

Since:

Sitevision 4.1

removeCollaborationGroup

boolean removeCollaborationGroup(Node aCollaborationGroup)

Removes a collaboration group.

Note! When a collaboration group (sv:collaborationGroup) is removed, its collaboration group page (sv:collaborationGroupPage) is moved to the trashcan.

Permission note! To remove a collaboration group current user must have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP on the collaboration group page.

Parameters:

aCollaborationGroup - a collaboration group to remove

Returns:

true if aCollaborationGroup was removed, i.e. collaboration group page was moved to trashcan, false otherwise.

Since:

Sitevision 4.5.3