senselogic.sitevision.api.collaboration

Interface CollaborationGroupTemplateUtil

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

Collaboration group template utility interface that handles nodes with primary node type sv:collaborationGroupTemplate.

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

Since:

Sitevision 3.6.4

Author:

Magnus Lövgren

See Also:

TemplateUtil

Method Summary

Modifier and Type	Method and Description
Node	getCollaborationGroupTemplateByName(String aCollaborationGroupTemplateName) Gets the first found collaboration group template that matches a given name.
List<Node>	getCollaborationGroupTemplates() Gets all collaboration group templates.
Node	getDefaultCollaborationGroupTemplate() Gets the default collaboration group template.

Method Detail

getDefaultCollaborationGroupTemplate

Node getDefaultCollaborationGroupTemplate()

Gets the default collaboration group template.

The default collaboration group template is the template that are used by default to create new collaboration groups (i.e. collaboration group pages).

Permission note! Current user must have PermissionUtil.Permission.READ on default collaboration group template.

Returns:

the default collaboration group template, or null if indeterminable

getCollaborationGroupTemplateByName

Node getCollaborationGroupTemplateByName(String aCollaborationGroupTemplateName)

Gets the first found collaboration group template that matches a given name.

Permission note! Only collaboration group templates that current user has PermissionUtil.Permission.READ on will be considered.

Parameters:

aCollaborationGroupTemplateName - name of the template

Returns:

a collaboration group template, or null if indeterminable (e.g. no accessible collaboration group template named aCollaborationGroupTemplateName could be found)

Since:

Sitevision 4.1

getCollaborationGroupTemplates

List<Node> getCollaborationGroupTemplates()

Gets all collaboration group templates.

Permission note! The list will only contain collaboration group templates that current user has PermissionUtil.Permission.READ on.

Returns:

all collaboration group templates, or empty list if there are no accessible collaboration group templates.

Since:

Sitevision 4.1