wt.access
Class AdHocAccessKey

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

All Implemented Interfaces:

Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

public class AdHocAccessKey
extends EnumeratedType
implements Serializable

AdHocAccessKey is a specialization of EnumeratedType to provide localizable owner keys for ad hoc access control rule entries. The localized values for owner keys are maintained in a resource bundle AdHocAccessKeyRB, and its locale derivatives.

An owner key is used to identify the service owning an ad hoc access control rule entry (WTAclEntry). Access control service methods used for creating ad hoc entries include an owner_key parameter. They also allow the entry's owner to optionally specify an owner_id parameter, which is a nonzero long identifier used to further qualify the key.

Supported API: true

Extendable: false

See Also:

AdHocControlled, WTAclEntry, Serialized Form

Field Summary

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

Method Summary

static AdHocAccessKey	getAdHocAccessKeyDefault() Returns the default value (instance) for the AdHocAccessKey set.
static AdHocAccessKey[]	getAdHocAccessKeySet() Returns a copy of the set of valid values (instances) for the AdHocAccessKey class.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static AdHocAccessKey	toAdHocAccessKey(String internal_value) Returns the AdHocAccessKey instance for the internal_value argument.

Methods inherited from class wt.fc.EnumeratedType

equals, getAbbreviatedDisplay, getDisplay, getDisplay, getFullDisplay, getLocalizedMessage, getLongDescription, getOrder, getSelectableValueSet, getShortDescription, getStringValue, getStringValue, hashCode, isDefaultValue, isDefaultValue, isSelectable, main, toEnumeratedType, toEnumeratedType, toString

Methods inherited from class java.lang.Object

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

Method Detail

toAdHocAccessKey

public static AdHocAccessKey toAdHocAccessKey(String internal_value)
                                       throws WTInvalidParameterException

Returns the AdHocAccessKey instance for the internal_value argument.

Supported API: true

Parameters:

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

Returns:

AdHocAccessKey

Throws:

WTInvalidParameterException

getAdHocAccessKeyDefault

public static AdHocAccessKey getAdHocAccessKeyDefault()

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

Supported API: true

Returns:

AdHocAccessKey

getAdHocAccessKeySet

public static AdHocAccessKey[] getAdHocAccessKeySet()

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

Supported API: true

Returns:

AdHocAccessKey[]

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[]