wt.workflow.engine
Class WfConnectorAction

java.lang.Object
  wt.fc.EnumeratedType
      wt.workflow.engine.WfConnectorAction

All Implemented Interfaces:

EnumeratedType, LocalizableMessage, LocalizableMetadata, Message, Serializable

public class WfConnectorAction

extends EnumeratedType

implements Serializable

WfConnectorType enumerates the possible actions that can be carried out by connectors. These are the following:

• FIRE - indicates that an input to the connector was activated; this may result in the firing of the connector, depending on the connector's state, function and the state of the other inputs to the connector;
• ENABLE - enables the connector, that is, changes the connector state to 'enabled'
• DISABLE - disables the connector, that is, changes the connector state to 'disabled'
• PLUS_ONE - adds one to connector's threshold: this action is only valid for threshold connectors
• MINUS_ONE - subtracts one from connector's threshold if this is greater than zero: does nothing if threshold is alreadyzero. This action is only valid for threshold connectors

Supported API: false

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
static WfConnectorAction	DISABLE Supported API: false
static WfConnectorAction	ENABLE Supported API: false
static WfConnectorAction	FIRE Supported API: false
private static Hashtable	localeSets
static WfConnectorAction	MINUS_ONE Supported API: false
static WfConnectorAction	PLUS_ONE Supported API: false
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

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

Method Summary

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.
static WfConnectorAction	getWfConnectorActionDefault() Returns the default value (instance) for the WfConnectorAction set.
static WfConnectorAction[]	getWfConnectorActionSet() Returns a copy of the set of valid values (instances) for the WfConnectorAction class.
private static EnumeratedType[]	initializeLocaleSet(Locale locale)
static WfConnectorAction	newWfConnectorAction(int secretHandshake) Used by EnumeratedType for constructing instances of WfConnectorAction, from a resource bundle.
static WfConnectorAction	toWfConnectorAction(String internal_value) Returns the WfConnectorAction 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

FIRE

public static final WfConnectorAction FIRE

Supported API: false

ENABLE

public static final WfConnectorAction ENABLE

Supported API: false

DISABLE

public static final WfConnectorAction DISABLE

Supported API: false

PLUS_ONE

public static final WfConnectorAction PLUS_ONE

Supported API: false

MINUS_ONE

public static final WfConnectorAction MINUS_ONE

Supported API: false

Constructor Detail

WfConnectorAction

protected WfConnectorAction()

Used by sub-classes that need a default constructor.

Supported API: false

Method Detail

newWfConnectorAction

public static WfConnectorAction newWfConnectorAction(int secretHandshake)
                                              throws IllegalAccessException

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

Supported API: false

Parameters:

secretHandshake -

Returns:

WfConnectorAction

Throws:

IllegalAccessException

toWfConnectorAction

public static WfConnectorAction toWfConnectorAction(String internal_value)
                                             throws WTInvalidParameterException

Returns the WfConnectorAction instance for the internal_value argument.

Supported API: false

Parameters:

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

Returns:

WfConnectorAction

Throws:

WTInvalidParameterException

getWfConnectorActionDefault

public static WfConnectorAction getWfConnectorActionDefault()

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

Supported API: false

Returns:

WfConnectorAction

getWfConnectorActionSet

public static WfConnectorAction[] getWfConnectorActionSet()

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

Supported API: false

Returns:

WfConnectorAction[]

getValueSet

public EnumeratedType[] getValueSet()

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

Supported API: false

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