com.beasys.commerce.foundation
Class StateImpl

java.lang.Object
  |
  +--com.beasys.commerce.foundation.BelongingImpl
        |
        +--com.beasys.commerce.foundation.StateImpl

All Implemented Interfaces:

Belonging, BusinessSmartComponent, java.lang.Cloneable, java.lang.Comparable, RelationalReference, java.io.Serializable, State

public class StateImpl

extends BelongingImpl

implements State

Represents a discrete state in a state machine or workflow. It is contained by a StateMachine and refered to by Transitions

See Also:

State, StateHome, Serialized Form

Field Summary

java.lang.String

name A name that identifies the state uniquely within the context of a state machine.

Fields inherited from class com.beasys.commerce.foundation.BelongingImpl

__classIdentifier, __containingBelonging, __containingEntity, __mapKey, __sequenceNumber, _isDirty

Constructor Summary

StateImpl()

Method Summary

int	compareTo(java.lang.Object o) Compares a given object with this Belonging.
void	enter(Transition trans) This method is invoked whenever the state is entered.
void	error(Transition trans) This method is invoked whenever the state is transitioned from in erro.
void	exit(Transition trans) This method is invoked whenever the state is transitioned from.
TransitionPolicy	getEnterPolicy() Get the transition policy that is invoked when the state is entered.
TransitionPolicy	getErrorPolicy() Set the transition policy that is invoked when the state is exited with an invalid transition.
TransitionPolicy	getExitPolicy() Get the transition policy that is invoked when the state is exited.
java.lang.String	getName() Get the value of name
java.lang.String	interfaceName() Returns the unqualified name of the interface as specified in the UML model.
void	setByValue(Belonging value) Intializes the Belonging based upon a supplied Belonging.
void	setEnterPolicy(TransitionPolicy policy) Set a transition policy that is invoked when the state is entered.
void	setErrorPolicy(TransitionPolicy policy) Set a transition policy that is invoked when the state is exited with an invalid transition.
void	setExitPolicy(TransitionPolicy policy) Set a transition policy that is invoked when the state is exited.
void	setName(java.lang.String name) Set the value of name
Belonging	value() Returns a type safe shallow copy of the Belonging instance.

Methods inherited from class com.beasys.commerce.foundation.BelongingImpl

clearRelationalBinding, clearRelationalBinding, clearRelationalBinding, clearRelationalBinding, clone, doRelationalBinding, doRelationalBinding, doRelationalBindingOnElement, doRelationalBindingOnElement, doRelationalBindingOnElement, doRelationalBindingOnSingleton, doRelationalBindingOnSingleton, doRelationalBindingOnSingleton, doRelationalBindingWithMapKey, doRelationalBindingWithMapKey, doRelationalBindingWithMapKey, enumerateRelationalBinding, enumerateRelationalBinding, equals, get__classIdentifier, get__containingBelonging, get__containingEntity, get__containingEntityReference, get__mapKey, get__sequenceNumber,

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.beasys.commerce.foundation.Belonging

clone, equals

Field Detail

name

public java.lang.String name

A name that identifies the state uniquely within the context of a state machine.

                  name
 [State] <*>------> [java.lang.String] 

 

Constructor Detail

StateImpl

public StateImpl()

Method Detail

getName

public java.lang.String getName()

Get the value of name

Specified by:

getName in interface State

Returns:

name.

setName

public void setName(java.lang.String name)

Set the value of name

Specified by:

setName in interface State

Parameters:

name - name to be added

value

public Belonging value()

Description copied from interface: Belonging

Returns a type safe shallow copy of the Belonging instance.

Specified by:

value in interface Belonging

Following copied from interface: com.beasys.commerce.foundation.Belonging

Returns:

A type safe shallow copy of this Belonging.

interfaceName

public java.lang.String interfaceName()

Description copied from interface: Belonging

Returns the unqualified name of the interface as specified in the UML model.

Specified by:

interfaceName in interface Belonging

Following copied from interface: com.beasys.commerce.foundation.Belonging

Returns:

The unqualified name of the belonging interface.

setByValue

public void setByValue(Belonging value)

Description copied from interface: Belonging

Intializes the Belonging based upon a supplied Belonging.

Specified by:

setByValue in interface Belonging

Overrides:

setByValue in class BelongingImpl

Following copied from interface: com.beasys.commerce.foundation.Belonging

Parameters:

belonging - The Belonging to use for initialization.

compareTo

public int compareTo(java.lang.Object o)

Description copied from class: BelongingImpl

Compares a given object with this Belonging.

Specified by:

compareTo in interface java.lang.Comparable

Overrides:

compareTo in class BelongingImpl

Following copied from class: com.beasys.commerce.foundation.BelongingImpl

Parameters:

o - the Object to be compared.

Returns:

a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.

Throws:

java.lang.ClassCastException - if the specified object is not of the same type as this Belonging.

enter

public void enter(Transition trans)

This method is invoked whenever the state is entered. It searches for an enter policy and invokes it.

Specified by:

enter in interface State

exit

public void exit(Transition trans)

This method is invoked whenever the state is transitioned from. It searches for an Exit Policy and invokes it if present.

Specified by:

exit in interface State

error

public void error(Transition trans)

This method is invoked whenever the state is transitioned from in erro. It searches for an Error Policy and invokes it if present

Specified by:

error in interface State

setEnterPolicy

public void setEnterPolicy(TransitionPolicy policy)

Set a transition policy that is invoked when the state is entered.

Specified by:

setEnterPolicy in interface State

getEnterPolicy

public TransitionPolicy getEnterPolicy()

Get the transition policy that is invoked when the state is entered.

Specified by:

getEnterPolicy in interface State

setExitPolicy

public void setExitPolicy(TransitionPolicy policy)

Set a transition policy that is invoked when the state is exited.

Specified by:

setExitPolicy in interface State

getExitPolicy

public TransitionPolicy getExitPolicy()

Get the transition policy that is invoked when the state is exited.

Specified by:

getExitPolicy in interface State

setErrorPolicy

public void setErrorPolicy(TransitionPolicy policy)

Set a transition policy that is invoked when the state is exited with an invalid transition.

Specified by:

setErrorPolicy in interface State

getErrorPolicy

public TransitionPolicy getErrorPolicy()

Set the transition policy that is invoked when the state is exited with an invalid transition.

Specified by:

getErrorPolicy in interface State