wt.access
Class AccessPermission

java.lang.Object
  wt.fc.EnumeratedType
      wt.access.AccessPermission

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class AccessPermission

extends EnumeratedType

implements Serializable

AccessPermission represents the access control permissions that may be granted or denied.

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.EnumeratedType

Field Summary

static AccessPermission	ADMINISTRATIVE Administrative permission Supported API: true
static AccessPermission	ALL Full control (all permissions) Supported API: true
private static long	ALL_MASK Mask for all permissions
static AccessPermission	ATTACH Deprecated.
static AccessPermission	CHANGE_PERMISSIONS Change permissions permission Supported API: true
private static String	CLASS_RESOURCE
private static String	CLASSNAME
static AccessPermission	CREATE Create permission Supported API: true
static AccessPermission	DELETE Delete permission Supported API: true
private static Hashtable	localeSets
static AccessPermission	MODIFY Modify permission Supported API: true
static AccessPermission	NEW_VIEW_VERSION New View Version permission Supported API: true
static String	PRE63_ADMINISTRATIVE
static String	PRE63_ALL
static String	PRE63_CREATE
static String	PRE63_DELETE
static String	PRE63_MODIFY
static String	PRE63_READ
static AccessPermission	READ Read permission Supported API: true
private static String	RESOURCE
static AccessPermission	REVISE Revise permission Supported API: true
static AccessPermission	USE Deprecated.
private static EnumeratedType[]	valueSet

Fields inherited from class wt.fc.EnumeratedType

secretHandshake, SEP_CHAR

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Constructor Summary

protected

AccessPermission() Used by sub-classes that need a default constructor.

Method Summary

static AccessPermission	getAccessPermissionDefault() Returns the default value (instance) for the AccessPermission set.
static AccessPermission[]	getAccessPermissionSet() Returns a copy of the set of valid values (instances) for the AccessPermission class.
protected EnumeratedType[]	getLocaleSet(Locale locale) Returns the set of values (instances) for this instance, for the specified locale.
static long	getPermissionMask(AccessPermission permission) Returns a mask corresponding to the specified permission.
static long	getPermissionMask(Collection permissions) Returns a mask corresponding to the specified permissions.
static EnumeratorVector	getPermissions(long mask) Returns the permissions represented by the specified mask, as an EnumeratorVector.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
private static EnumeratedType[]	initializeLocaleSet(Locale locale)
static AccessPermission	newAccessPermission(int secretHandshake) Used by EnumeratedType for constructing instances of AccessPermission, from a resource bundle.
static AccessPermission	toAccessPermission(String internal_value) Returns the AccessPermission instance for the internal_value argument.
protected EnumeratedType[]	valueSet() Returns a reference to the set of valid values (instances) for this instance.

Methods inherited from class wt.fc.EnumeratedType

defaultEnumeratedType, dynamicInstance, equals, getAbbreviatedDisplay, getComment, getComment, getDisplay, getDisplay, getFullDisplay, getInternalKey, getLocalizedMessage, getLocalizedValues, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getShortDescription, getStringValue, getStringValue, getValidSet, getValue, hashCode, instantiateSet, isDefaultValue, isDefaultValue, isPrimaryKey, isSelectable, main, readResolve, toEnumeratedType, toEnumeratedType, toEnumeratedType, toString, validateFriendship

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

CLASS_RESOURCE

private static final String CLASS_RESOURCE

See Also:

Constant Field Values

valueSet

private static final EnumeratedType[] valueSet

localeSets

private static Hashtable localeSets

ALL_MASK

private static final long ALL_MASK

Mask for all permissions

See Also:

Constant Field Values

PRE63_ALL

public static final String PRE63_ALL

See Also:

Constant Field Values

PRE63_READ

public static final String PRE63_READ

See Also:

Constant Field Values

PRE63_MODIFY

public static final String PRE63_MODIFY

See Also:

Constant Field Values

PRE63_CREATE

public static final String PRE63_CREATE

See Also:

Constant Field Values

PRE63_DELETE

public static final String PRE63_DELETE

See Also:

Constant Field Values

PRE63_ADMINISTRATIVE

public static final String PRE63_ADMINISTRATIVE

See Also:

Constant Field Values

ALL

public static final AccessPermission ALL

Full control (all permissions)

Supported API: true

READ

public static final AccessPermission READ

Read permission

Supported API: true

MODIFY

public static final AccessPermission MODIFY

Modify permission

Supported API: true

CREATE

public static final AccessPermission CREATE

Create permission

Supported API: true

REVISE

public static final AccessPermission REVISE

Revise permission

Supported API: true

NEW_VIEW_VERSION

public static final AccessPermission NEW_VIEW_VERSION

New View Version permission

Supported API: true

DELETE

public static final AccessPermission DELETE

Delete permission

Supported API: true

CHANGE_PERMISSIONS

public static final AccessPermission CHANGE_PERMISSIONS

Change permissions permission

Supported API: true

ADMINISTRATIVE

public static final AccessPermission ADMINISTRATIVE

Administrative permission

Supported API: true

USE

public static final AccessPermission USE

Deprecated.

Use permission

Supported API: false

ATTACH

public static final AccessPermission ATTACH

Deprecated.

Attach permission

Supported API: false

Constructor Detail

AccessPermission

protected AccessPermission()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newAccessPermission

public static AccessPermission newAccessPermission(int secretHandshake)
                                            throws IllegalAccessException

Used by EnumeratedType for constructing instances of AccessPermission, from a resource bundle.

Supported API: false

Parameters:

secretHandshake -

Returns:

AccessPermission

Throws:

IllegalAccessException

toAccessPermission

public static AccessPermission toAccessPermission(String internal_value)
                                           throws WTInvalidParameterException

Returns the AccessPermission instance for the internal_value argument.

Supported API: true

Parameters:

internal_value - The internal (persistent) value for a valid instance of AccessPermission.

Returns:

AccessPermission

Throws:

WTInvalidParameterException

getAccessPermissionDefault

public static AccessPermission getAccessPermissionDefault()

Returns the default value (instance) for the AccessPermission set.

Supported API: true

Returns:

AccessPermission

getAccessPermissionSet

public static AccessPermission[] getAccessPermissionSet()

Returns a copy of the set of valid values (instances) for the AccessPermission class.

Supported API: true

Returns:

AccessPermission[]

getValueSet

public EnumeratedType[] getValueSet()

Returns a copy of the set of valid values (instances) for this instance, for the current user locale.

Supported API: true

Specified by:

getValueSet in class EnumeratedType

Returns:

EnumeratedType[]

valueSet

protected EnumeratedType[] valueSet()

Returns a reference to the set of valid values (instances) for this instance.

Supported API: false

Specified by:

valueSet in class EnumeratedType

Returns:

EnumeratedType[]

getLocaleSet

protected EnumeratedType[] getLocaleSet(Locale locale)

Returns the set of values (instances) for this instance, for the specified locale.

Supported API: false

Specified by:

getLocaleSet in class EnumeratedType

Parameters:

locale -

Returns:

EnumeratedType[]

initializeLocaleSet

private static EnumeratedType[] initializeLocaleSet(Locale locale)
                                             throws Throwable

Parameters:

locale -

Returns:

EnumeratedType[]

Throws:

Throwable

getPermissionMask

public static long getPermissionMask(AccessPermission permission)

Returns a mask corresponding to the specified permission.

Supported API: false

Parameters:

permission -

Returns:

long

getPermissionMask

public static long getPermissionMask(Collection permissions)

Returns a mask corresponding to the specified permissions.

Supported API: false

Parameters:

permissions - permissions (wt.util.Collection of AccessPermission)

Returns:

long

getPermissions

public static EnumeratorVector getPermissions(long mask)

Returns the permissions represented by the specified mask, as an EnumeratorVector.

Supported API: false

Parameters:

mask -

Returns:

EnumeratorVector