wt.epm.workspaces
Class EPMPopulateRule

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

All Implemented Interfaces:

Serializable, Comparable, EnumeratedType, LocalizableMetadata, LocalizableMessage, Message

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

Field Summary

static EPMPopulateRule	ALL Populate by traversing both required and optional dependencies.
static EPMPopulateRule	NONE Add only the one item performing no traversal.
static EPMPopulateRule	REQUIRED Populate traversing only required dependencies.

Fields inherited from interface wt.meta.EnumeratedType

DEFAULT_VALUE, ORDER, SELECTABLE

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.
EnumeratedType[]	getValueSet() Returns a copy of the set of valid values (instances) for this instance, for the current user locale.
static EPMPopulateRule	toEPMPopulateRule(String internal_value) Returns the EPMPopulateRule 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

Field Detail

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

Method Detail

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