fr.toutatice.portail.cms.nuxeo.api.workspace

Enum WorkspaceType

java.lang.Object

java.lang.Enum<WorkspaceType>

fr.toutatice.portail.cms.nuxeo.api.workspace.WorkspaceType

All Implemented Interfaces:

Serializable, Comparable<WorkspaceType>

public enum WorkspaceType
extends Enum<WorkspaceType>

Workspace types enumeration.

Author:

Cédric Krommenhoek

Enum Constant Summary

Enum Constants

Enum Constant and Description
INVITATION Invitation only private workspace.
PRIVATE Private workspace.
PUBLIC Public workspace.
PUBLIC_INVITATION Invitation only public workspace.
UNCHANGEABLE Unchangeable workspace.

Method Summary

Modifier and Type	Method and Description
String	getColor() Getter for color.
String	getIcon() Getter for icon.
String	getId() Getter for id.
String	getKey() Getter for key.
boolean	isAllowedInvitationRequests() Getter for allowedInvitationRequests.
boolean	isPortalAdministratorRestriction() Getter for portalAdministratorRestriction.
static List<WorkspaceType>	list(boolean admin) Get workspace types values.
static WorkspaceType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WorkspaceType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

PUBLIC

public static final WorkspaceType PUBLIC

Public workspace.

PUBLIC_INVITATION

public static final WorkspaceType PUBLIC_INVITATION

Invitation only public workspace.

PRIVATE

public static final WorkspaceType PRIVATE

Private workspace.

INVITATION

public static final WorkspaceType INVITATION

Invitation only private workspace.

UNCHANGEABLE

public static final WorkspaceType UNCHANGEABLE

Unchangeable workspace.

Method Detail

values

public static WorkspaceType[] 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 (WorkspaceType c : WorkspaceType.values())
    System.out.println(c);

Returns:

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

valueOf

public static WorkspaceType 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

getId

public String getId()

Getter for id.

Returns:

the id

getKey

public String getKey()

Getter for key.

Returns:

the key

getIcon

public String getIcon()

Getter for icon.

Returns:

the icon

getColor

public String getColor()

Getter for color.

Returns:

the color

isAllowedInvitationRequests

public boolean isAllowedInvitationRequests()

Getter for allowedInvitationRequests.

Returns:

the allowedInvitationRequests

list

public static List<WorkspaceType> list(boolean admin)

Get workspace types values.

Parameters:

admin - portal administrator indicator

Returns:

workspace types

isPortalAdministratorRestriction

public boolean isPortalAdministratorRestriction()

Getter for portalAdministratorRestriction.

Returns:

the portalAdministratorRestriction