wt.epm.clients.relateditems
Class IncludedAs

java.lang.Object
  wt.fc.EnumeratedType
      wt.epm.clients.relateditems.IncludedAs

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class IncludedAs

extends EnumeratedType

implements Serializable

An enumerated type listing the valid authoring applications for an EPMObject.

For example, 'PROE'.

Customers may add new authoring application types by adding additional values to the associated resource bundle, IncludedAsRB.

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.EnumeratedType

Field Summary

private static String	CLASS_RESOURCE
private static String	CLASSNAME
private static Hashtable	localeSets
private static String	RESOURCE
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

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

Method Summary

static IncludedAs	getIncludedAsDefault() Returns the default value (instance) for the IncludedAs set.
static IncludedAs[]	getIncludedAsSet() Returns a copy of the set of valid values (instances) for the IncludedAs class.
protected EnumeratedType[]	getLocaleSet(Locale locale) Returns the set of values (instances) for this instance, for the specified locale.
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 IncludedAs	newIncludedAs(int secretHandshake) Used by EnumeratedType for constructing instances of IncludedAs, from a resource bundle.
static IncludedAs	toIncludedAs(String internal_value) Returns the IncludedAs 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

Constructor Detail

IncludedAs

protected IncludedAs()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newIncludedAs

public static IncludedAs newIncludedAs(int secretHandshake)
                                throws IllegalAccessException

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

Supported API: false

Parameters:

secretHandshake -

Returns:

IncludedAs

Throws:

IllegalAccessException

toIncludedAs

public static IncludedAs toIncludedAs(String internal_value)
                               throws WTInvalidParameterException

Returns the IncludedAs instance for the internal_value argument.

Supported API: true

Parameters:

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

Returns:

IncludedAs

Throws:

WTInvalidParameterException

getIncludedAsDefault

public static IncludedAs getIncludedAsDefault()

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

Supported API: true

Returns:

IncludedAs

getIncludedAsSet

public static IncludedAs[] getIncludedAsSet()

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

Supported API: true

Returns:

IncludedAs[]

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