wt.lifecycle
Class LifeCycleState

java.lang.Object
  wt.lifecycle.LifeCycleState

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public class LifeCycleState

extends Object

implements ObjectMappable, Externalizable

LifeCycleState is the state 'cookie' of the LifeCycleManaged interface. It encapsulates the implmentation of state.

Use the newLifeCycleState static factory method(s), not the LifeCycleState constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

State, LifeCycleManaged, Serialized Form

Field Summary

static String	AT_GATE Label for the attribute; An indication of whether or not the LifeCycleManged object is at the Gate Supported API: false
private boolean	atGate
private static String	CLASSNAME
static long	EXTERNALIZATION_VERSION_UID
static String	LIFE_CYCLE_ID Label for the attribute.
private LifeCycleTemplateReference	lifeCycleId
protected static long	OLD_FORMAT_VERSION_UID
private Phase	phase
static String	PHASE Label for the attribute.
private static String	RESOURCE
(package private) static long	serialVersionUID
private State	state
static String	STATE Label for the attribute; Enumerated state value Supported API: false
private static int	STATE_UPPER_LIMIT

Constructor Summary

LifeCycleState()

Method Summary

ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
LifeCycleTemplateReference	getLifeCycleId() Gets the object for the association that plays role: LIFE_CYCLE_ID.
Phase	getPhase() Gets the value of the attribute: PHASE.
State	getState() Gets the value of the attribute: STATE.
protected void	initialize() Supports initialization, following construction of an instance.
boolean	isAtGate() Gets the value of the attribute: AT_GATE.
private void	lifeCycleIdValidate(LifeCycleTemplateReference a_LifeCycleId)
static LifeCycleState	newLifeCycleState() Default factory for the class.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(LifeCycleState thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setAtGate(boolean a_AtGate) Sets the value of the attribute: AT_GATE.
void	setLifeCycleId(LifeCycleTemplateReference a_LifeCycleId) Sets the object for the association that plays role: LIFE_CYCLE_ID.
void	setPhase(Phase a_Phase) Sets the value of the attribute: PHASE.
void	setState(State a_State) Sets the value of the attribute: STATE.
private void	stateValidate(State a_State)
String	toString() Returns the conceptual (modeled) name for the class.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

STATE

public static final String STATE

Label for the attribute; Enumerated state value

Supported API: false

See Also:

Constant Field Values

STATE_UPPER_LIMIT

private static int STATE_UPPER_LIMIT

state

private State state

AT_GATE

public static final String AT_GATE

Label for the attribute; An indication of whether or not the LifeCycleManged object is at the Gate

Supported API: false

See Also:

Constant Field Values

atGate

private boolean atGate

PHASE

public static final String PHASE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

phase

private transient Phase phase

LIFE_CYCLE_ID

public static final String LIFE_CYCLE_ID

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

lifeCycleId

private LifeCycleTemplateReference lifeCycleId

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

LifeCycleState

public LifeCycleState()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(LifeCycleState thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

toString

public String toString()

Returns the conceptual (modeled) name for the class.

Supported API: false

Returns:

String

getClassInfo

public ClassInfo getClassInfo()
                       throws WTIntrospectionException

Returns the ClassInfo object for this class.

Supported API: false

Specified by:

getClassInfo in interface NetFactor

Returns:

ClassInfo

Throws:

WTIntrospectionException

getState

public State getState()

Gets the value of the attribute: STATE. Enumerated state value

Supported API: false

Returns:

State

setState

public void setState(State a_State)
              throws WTPropertyVetoException

Sets the value of the attribute: STATE. Enumerated state value

Supported API: false

Parameters:

a_State -

Throws:

WTPropertyVetoException

stateValidate

private void stateValidate(State a_State)
                    throws WTPropertyVetoException

Parameters:

a_State -

Throws:

WTPropertyVetoException

isAtGate

public boolean isAtGate()

Gets the value of the attribute: AT_GATE. An indication of whether or not the LifeCycleManged object is at the Gate

Supported API: false

Returns:

boolean

setAtGate

public void setAtGate(boolean a_AtGate)
               throws WTPropertyVetoException

Sets the value of the attribute: AT_GATE. An indication of whether or not the LifeCycleManged object is at the Gate

Supported API: false

Parameters:

a_AtGate -

Throws:

WTPropertyVetoException

getPhase

public Phase getPhase()

Gets the value of the attribute: PHASE.

Supported API: false

Returns:

Phase

setPhase

public void setPhase(Phase a_Phase)
              throws WTPropertyVetoException

Sets the value of the attribute: PHASE.

Supported API: false

Parameters:

a_Phase -

Throws:

WTPropertyVetoException

getLifeCycleId

public LifeCycleTemplateReference getLifeCycleId()

Gets the object for the association that plays role: LIFE_CYCLE_ID.

Supported API: false

Returns:

LifeCycleTemplateReference

setLifeCycleId

public void setLifeCycleId(LifeCycleTemplateReference a_LifeCycleId)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: LIFE_CYCLE_ID.

Supported API: false

Parameters:

a_LifeCycleId -

Throws:

WTPropertyVetoException

lifeCycleIdValidate

private void lifeCycleIdValidate(LifeCycleTemplateReference a_LifeCycleId)
                          throws WTPropertyVetoException

Parameters:

a_LifeCycleId -

Throws:

WTPropertyVetoException

newLifeCycleState

public static LifeCycleState newLifeCycleState()
                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

LifeCycleState

Throws:

WTException

initialize

protected void initialize()
                   throws WTException

Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

Supported API: false

Throws:

WTException