org.alfresco.bm.site

Enum SiteRole

java.lang.Object

java.lang.Enum<SiteRole>

org.alfresco.bm.site.SiteRole

All Implemented Interfaces:

Serializable, Comparable<SiteRole>

public enum SiteRole
extends Enum<SiteRole>

Site membership role based on site type.

Author:

steveglover

Enum Constant Summary

Enum Constants

Enum Constant and Description
SiteCollaborator
SiteConsumer
SiteContributor
SiteManager

Method Summary

Methods

Modifier and Type	Method and Description
static SiteRole	getRandomRole()
static SiteRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static SiteRole[]	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

SiteManager

public static final SiteRole SiteManager

SiteCollaborator

public static final SiteRole SiteCollaborator

SiteContributor

public static final SiteRole SiteContributor

SiteConsumer

public static final SiteRole SiteConsumer

Method Detail

values

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

Returns:

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

valueOf

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

getRandomRole

public static SiteRole getRandomRole()