org.pageseeder.bridge.model

Enum PSRole

java.lang.Object

java.lang.Enum<PSRole>

org.pageseeder.bridge.model.PSRole

All Implemented Interfaces:

Serializable, Comparable<PSRole>

public enum PSRole
extends Enum<PSRole>

A membership role.

Version:

0.1.0

Author:

Christophe Lauret

Enum Constant Summary

Enum Constants

Enum Constant and Description
approver 'Approver' role PageSeeder.
contributor 'Contributor' role PageSeeder.
guest 'Guest' role PageSeeder.
manager 'Manager' role PageSeeder.
moderator 'Moderator' role PageSeeder.
moderator_and_approver 'Mod & App' role PageSeeder.
reviewer 'Reviewer' role PageSeeder.

Method Summary

Methods

Modifier and Type	Method and Description
String	parameter()
String	parameterMixed() Deprecated. Mixed case is deprecated, but some services still require it.
static PSRole	valueOf(String name) Returns the enum constant of this type with the specified name.
static PSRole[]	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

guest

public static final PSRole guest

'Guest' role PageSeeder.

reviewer

public static final PSRole reviewer

'Reviewer' role PageSeeder.

contributor

public static final PSRole contributor

'Contributor' role PageSeeder.

manager

public static final PSRole manager

'Manager' role PageSeeder.

moderator

public static final PSRole moderator

'Moderator' role PageSeeder.

approver

public static final PSRole approver

'Approver' role PageSeeder.

moderator_and_approver

public static final PSRole moderator_and_approver

'Mod & App' role PageSeeder.

Method Detail

values

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

Returns:

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

valueOf

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

parameter

public String parameter()

Returns:

the parameter to use when communicating with PageSeder

parameterMixed

@Deprecated
public String parameterMixed()

Deprecated. Mixed case is deprecated, but some services still require it.

Returns:

the parameter to use when communicating with PageSeder using mixed case