com.saperion.ws.wrapper

Enum SaWsRight

java.lang.Object

java.lang.Enum<SaWsRight>

com.saperion.ws.wrapper.SaWsRight

All Implemented Interfaces:

Serializable, Comparable<SaWsRight>

public enum SaWsRight
extends Enum<SaWsRight>

Webservice enum to represent right flags.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ANNOTATIONS annotations.
BLACK_MARKER black marker.
DELETE delete.
EXPAND_INDEX expand index.
EXPORT_DOCUMENT export document.
MODIFY modify.
MODIFY_DATA modify data.
MODIFY_INDEX modify index.
PERMISSIONS permissions.
READ read.
READ_VERSION_HISTORY read version history.
RECORDS_MANAGEMENT records management.
RELEASE_DOCUMENT release document.
RESTORE_BLACK_MARKER restore black marker.
RESTORE_VERSION restore version.
VISIBLE visible.

Field Summary

Fields

Modifier and Type	Field and Description
static EnumSet<SaWsRight>	COMPLETE Enum set of all contained SaWsRights.
static List<SaWsRight>	COMPLETE_LIST List of all contained SaWsRights.

Method Summary

Modifier and Type	Method and Description
static List<SaWsRight>	fromBackend(com.saperion.rmi.SaACLRights aclRights) Creates and returns a list of SaWsRights from the given SaACLRights.
String	getSymbol() Returns the symbol (letter) of this instance.
static SaWsRight	valueOf(String name) Returns the enum constant of this type with the specified name.
static SaWsRight[]	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

VISIBLE

public static final SaWsRight VISIBLE

visible.

READ

public static final SaWsRight READ

read.

ANNOTATIONS

public static final SaWsRight ANNOTATIONS

annotations.

BLACK_MARKER

public static final SaWsRight BLACK_MARKER

black marker.

MODIFY_INDEX

public static final SaWsRight MODIFY_INDEX

modify index.

EXPAND_INDEX

public static final SaWsRight EXPAND_INDEX

expand index.

MODIFY_DATA

public static final SaWsRight MODIFY_DATA

modify data.

MODIFY

public static final SaWsRight MODIFY

modify.

DELETE

public static final SaWsRight DELETE

delete.

PERMISSIONS

public static final SaWsRight PERMISSIONS

permissions.

RESTORE_BLACK_MARKER

public static final SaWsRight RESTORE_BLACK_MARKER

restore black marker.

RELEASE_DOCUMENT

public static final SaWsRight RELEASE_DOCUMENT

release document.

READ_VERSION_HISTORY

public static final SaWsRight READ_VERSION_HISTORY

read version history.

RESTORE_VERSION

public static final SaWsRight RESTORE_VERSION

restore version.

EXPORT_DOCUMENT

public static final SaWsRight EXPORT_DOCUMENT

export document.

RECORDS_MANAGEMENT

public static final SaWsRight RECORDS_MANAGEMENT

records management.

Field Detail

COMPLETE

public static final EnumSet<SaWsRight> COMPLETE

Enum set of all contained SaWsRights.

COMPLETE_LIST

public static final List<SaWsRight> COMPLETE_LIST

List of all contained SaWsRights.

Method Detail

values

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

Returns:

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

valueOf

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

getSymbol

public String getSymbol()

Returns the symbol (letter) of this instance.

Returns:

the symbol of this instance.

fromBackend

public static List<SaWsRight> fromBackend(com.saperion.rmi.SaACLRights aclRights)

Creates and returns a list of SaWsRights from the given SaACLRights.

Parameters:

aclRights - the SaACLRights to map.

Returns:

the created list of SaWsRights.