senselogic.sitevision.api.collaboration

Enum CollaborationGroupState

Object

Enum<CollaborationGroupState>

senselogic.sitevision.api.collaboration.CollaborationGroupState

All Implemented Interfaces:

Serializable, Comparable<CollaborationGroupState>

@Requireable(value="CollaborationGroupState")
public enum CollaborationGroupState
extends Enum<CollaborationGroupState>

Collaboration group state.

Example of how to get the ACTIVE state:

• Using Velocity:

  
         #set ($instanceCreatorUtil = $sitevisionUtils.instanceCreatorUtil)
         #set ($enumClassName = 'senselogic.sitevision.api.collaboration.CollaborationGroupState')
         #set ($activeEnum = $instanceCreatorUtil.getEnumInstance($enumClassName, 'ACTIVE'))

• Using server-side JavaScript:

  
         var activeEnum = require('CollaborationGroupState.ACTIVE');

Since:

Sitevision 4.1

Author:

Magnus Lövgren

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTIVE The active state.
INACTIVE The inactive state.

Method Summary

Modifier and Type	Method and Description
static CollaborationGroupState	valueOf(String name) Returns the enum constant of this type with the specified name.
static CollaborationGroupState[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTIVE

@Requireable(value="CollaborationGroupState.ACTIVE")
public static final CollaborationGroupState ACTIVE

The active state.

An active collaboration group is in use. Members can be added/removed and content can be added/removed.

INACTIVE

@Requireable(value="CollaborationGroupState.INACTIVE")
public static final CollaborationGroupState INACTIVE

The inactive state.

An inactive collaboration group is locked/archived. Members can not be added/removed and content can not be added/removed.

Method Detail

values

public static CollaborationGroupState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CollaborationGroupState c : CollaborationGroupState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CollaborationGroupState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null