wt.epm.workspaces
Class EPMPopulateRule

java.lang.Object
  wt.fc.EnumeratedType
      wt.epm.workspaces.EPMPopulateRule

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class EPMPopulateRule

extends EnumeratedType

implements Serializable

The EPMPopulateRule describes what dependent objects will be entered into the workspace when an object is added to teh workspace.

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

Nested classes inherited from class wt.fc.EnumeratedType

Field Summary

static EPMPopulateRule	ALL Populate by traversing both required and optional dependencies.
private static String	CLASS_RESOURCE
private static String	CLASSNAME
private static Hashtable	localeSets
static EPMPopulateRule	NONE Add only the one item performing no traversal.
static EPMPopulateRule	REQUIRED Populate traversing only required dependencies.
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

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

Method Summary

static EPMPopulateRule	getEPMPopulateRuleDefault() Returns the default value (instance) for the EPMPopulateRule set.
static EPMPopulateRule[]	getEPMPopulateRuleSet() Returns a copy of the set of valid values (instances) for the EPMPopulateRule 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 EPMPopulateRule	newEPMPopulateRule(int secretHandshake) Used by EnumeratedType for constructing instances of EPMPopulateRule, from a resource bundle.
static EPMPopulateRule	toEPMPopulateRule(String internal_value) Returns the EPMPopulateRule 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

public static final EPMPopulateRule ALL

Populate by traversing both required and optional dependencies.

Supported API: true

REQUIRED

public static final EPMPopulateRule REQUIRED

Populate traversing only required dependencies.

Supported API: true

NONE

public static final EPMPopulateRule NONE

Add only the one item performing no traversal.

Supported API: true

Constructor Detail

EPMPopulateRule

protected EPMPopulateRule()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newEPMPopulateRule

public static EPMPopulateRule newEPMPopulateRule(int secretHandshake)
                                          throws IllegalAccessException

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

Supported API: false

Parameters:

secretHandshake -

Returns:

EPMPopulateRule

Throws:

IllegalAccessException

toEPMPopulateRule

public static EPMPopulateRule toEPMPopulateRule(String internal_value)
                                         throws WTInvalidParameterException

Returns the EPMPopulateRule instance for the internal_value argument.

Supported API: true

Parameters:

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

Returns:

EPMPopulateRule

Throws:

WTInvalidParameterException

getEPMPopulateRuleDefault

public static EPMPopulateRule getEPMPopulateRuleDefault()

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

Supported API: true

Returns:

EPMPopulateRule

getEPMPopulateRuleSet

public static EPMPopulateRule[] getEPMPopulateRuleSet()

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

Supported API: true

Returns:

EPMPopulateRule[]

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