senselogic.sitevision.api.collaboration

Interface CollaborationGroupFolderUtil

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

Collaboration group folder utility interface that handles nodes with primary node type sv:collaborationGroupFolder.

An instance of the Sitevision class implementing this interface can be obtained via CollaborationFactory.getCollaborationGroupFolderUtil(). 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
boolean	containsCollaborationGroup(Node aCollaborationGroupFolder, String aGroupName) Whether or not a collaboration group folder already contains a named collaboration group.
Node	createCollaborationGroupFolder(Node aParent, String aGroupFolderName) Creates a collaboration group folder.
Node	getDefaultCollaborationGroupFolder() Gets the default collaboration group folder.

Method Detail

getDefaultCollaborationGroupFolder

Node getDefaultCollaborationGroupFolder()

Gets the default collaboration group folder.

The default collaboration group folder is the folder where new collaboration groups (i.e. collaboration group pages) are created by default.

Returns:

the default collaboration group folder, or null if indeterminable

containsCollaborationGroup

boolean containsCollaborationGroup(Node aCollaborationGroupFolder,
                                   String aGroupName)
                            throws RepositoryException

Whether or not a collaboration group folder already contains a named collaboration group.

Parameters:

aCollaborationGroupFolder - the collaboration group folder

aGroupName - the name of the collaboration group

Returns:

true if aCollaborationGroupFolder contains (case ignored) a group named aGroupName, false otherwise

Throws:

NullPointerException - if aCollaborationGroupFolder or aGroupName is null

RepositoryException - if aCollaborationGroupFolder is not a collaboration folder

createCollaborationGroupFolder

Node createCollaborationGroupFolder(Node aParent,
                                    String aGroupFolderName)
                             throws ConstraintViolationException,
                                    RepositoryException

Creates a collaboration group folder.

Permission note! Current user must have PermissionUtil.Permission.CREATE_COLLABORATION_GROUP_FOLDER on the parent where the collaboration group folder is created.

Parameters:

aParent - the parent node of the sv:collaborationGroupFolder. May not be null

aGroupFolderName - the name of the collaboration group folder. May not be null or whitespace-only

Returns:

The created collaboration group folder (sv:collaborationGroupFolder)

Throws:

NullPointerException - if aParent or aGroupFolderName is null

IllegalArgumentException - if aGroupFolderName is whitespace only

ConstraintViolationException - if social collaboration is not enabled on the site of aParent, if aParent is of invalid type, or if current user is not authorized to create the collaboration group folder

RepositoryException - if something else goes wrong

Since:

Sitevision 2025.04.1