wt.vc
Class IterationInfo

java.lang.Object
  wt.vc.IterationInfo

All Implemented Interfaces:

Externalizable, NetFactor, ObjectMappable, Serializable

public final class IterationInfo

extends Object

implements ObjectMappable, Externalizable

Holds an iteration's state as a cookie for client-side operations. The foreign key plus the "latest" boolean gives a system unique criteria for finding a single significant iteration.

Use the newIterationInfo static factory method(s), not the IterationInfo 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:

Serialized Form

Field Summary

static String	BRANCH_ID Label for the attribute; An identifier that uniquely labels an iteration line (i.e., a branch).
private long	branchId
private static String	CLASSNAME
private WTPrincipalReference	creator
static String	CREATOR Label for the attribute; The creator of the Version.
static long	EXTERNALIZATION_VERSION_UID
private IterationIdentifier	identifier
static String	IDENTIFIER Label for the attribute; The iteration's identifier.
static String	ITERATED_CLASS Label for the attribute.
private Class	iteratedClass
private boolean	latest
static String	LATEST Label for the attribute; An indicator of whether or not the iteration is the latest one.
private WTPrincipalReference	modifier
static String	MODIFIER Label for the attribute; The modifier of the business object (i.e., its iteration).
private String	note
static String	NOTE Label for the attribute; The note that documents the creation of the iteration.
private static int	NOTE_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private ObjectReference	predecessor
static String	PREDECESSOR Label for the attribute; The iteration's predecessor.
private static String	RESOURCE
(package private) static long	serialVersionUID
private IterationState	state
static String	STATE Label for the attribute.
private static int	STATE_UPPER_LIMIT

Constructor Summary

IterationInfo()

Method Summary

private void	creatorValidate(WTPrincipalReference a_Creator)
long	getBranchId() Gets the value of the attribute: BRANCH_ID.
ClassInfo	getClassInfo() Returns the ClassInfo object for this class.
String	getConceptualClassname() Deprecated.
WTPrincipalReference	getCreator() Gets the object for the association that plays role: CREATOR.
WTPrincipalReference	getCreatorOrig() Gets the value of the attribute: CREATOR.
IterationIdentifier	getIdentifier() Gets the object for the association that plays role: IDENTIFIER.
Class	getIteratedClass() Gets the value of the attribute: ITERATED_CLASS.
WTPrincipalReference	getModifier() Gets the object for the association that plays role: MODIFIER.
String	getNote() Gets the value of the attribute: NOTE.
ObjectReference	getPredecessor() Gets the object for the association that plays role: PREDECESSOR.
IterationState	getState() Gets the object for the association that plays role: STATE.
private void	identifierValidate(IterationIdentifier a_Identifier)
protected void	initialize() Supports initialization, following construction of an instance.
boolean	isLatest() Gets the value of the attribute: LATEST.
private void	modifierValidate(WTPrincipalReference a_Modifier)
static IterationInfo	newIterationInfo() Default factory for the class.
private void	noteValidate(String a_Note)
private void	predecessorValidate(ObjectReference a_Predecessor)
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(IterationInfo thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
protected void	setBranchId(long a_BranchId) Sets the value of the attribute: BRANCH_ID.
protected void	setCreator(WTPrincipalReference a_Creator) Sets the object for the association that plays role: CREATOR.
protected void	setIdentifier(IterationIdentifier a_Identifier) Sets the object for the association that plays role: IDENTIFIER.
void	setIteratedClass(Class a_IteratedClass) Sets the value of the attribute: ITERATED_CLASS.
protected void	setLatest(boolean a_Latest) Sets the value of the attribute: LATEST.
protected void	setModifier(WTPrincipalReference a_Modifier) Sets the object for the association that plays role: MODIFIER.
protected void	setNote(String a_Note) Sets the value of the attribute: NOTE.
protected void	setPredecessor(ObjectReference a_Predecessor) Sets the object for the association that plays role: PREDECESSOR.
void	setState(IterationState a_State) Sets the object for the association that plays role: STATE.
private void	stateValidate(IterationState 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

NOTE

public static final String NOTE

Label for the attribute; The note that documents the creation of the iteration.

Supported API: false

See Also:

Constant Field Values

NOTE_UPPER_LIMIT

private static int NOTE_UPPER_LIMIT

note

private String note

LATEST

public static final String LATEST

Label for the attribute; An indicator of whether or not the iteration is the latest one.

Supported API: false

See Also:

Constant Field Values

latest

private boolean latest

BRANCH_ID

public static final String BRANCH_ID

Label for the attribute; An identifier that uniquely labels an iteration line (i.e., a branch). It can act as part of a foreign key for query. If the object is not only Iterated but also Versioned this identifier is unique per iteration line. When a new iteration is constructed (the first to exist in an iteration line) this identifier is assigned a value from the POM's OID pool. This ensures that the identifier is unique within the system even compared to the "long" field of any object's OID.

Supported API: false

See Also:

Constant Field Values

branchId

private long branchId

ITERATED_CLASS

public static final String ITERATED_CLASS

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

iteratedClass

private Class iteratedClass

IDENTIFIER

public static final String IDENTIFIER

Label for the attribute; The iteration's identifier.

Supported API: false

See Also:

Constant Field Values

identifier

private IterationIdentifier identifier

MODIFIER

public static final String MODIFIER

Label for the attribute; The modifier of the business object (i.e., its iteration).

Supported API: false

See Also:

Constant Field Values

modifier

private WTPrincipalReference modifier

PREDECESSOR

public static final String PREDECESSOR

Label for the attribute; The iteration's predecessor.

Supported API: false

See Also:

Constant Field Values

predecessor

private ObjectReference predecessor

STATE

public static final String STATE

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

STATE_UPPER_LIMIT

private static int STATE_UPPER_LIMIT

state

private IterationState state

CREATOR

public static final String CREATOR

Label for the attribute; The creator of the Version. (ie first iteration on this branch)

Supported API: false

See Also:

Constant Field Values

creator

private WTPrincipalReference creator

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

IterationInfo

public IterationInfo()

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(IterationInfo 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

getNote

public String getNote()

Gets the value of the attribute: NOTE. The note that documents the creation of the iteration.

Supported API: false

Returns:

String

setNote

protected void setNote(String a_Note)
                throws WTPropertyVetoException

Sets the value of the attribute: NOTE. The note that documents the creation of the iteration.

Supported API: false

Parameters:

a_Note -

Throws:

WTPropertyVetoException

noteValidate

private void noteValidate(String a_Note)
                   throws WTPropertyVetoException

Parameters:

a_Note -

Throws:

WTPropertyVetoException

isLatest

public boolean isLatest()

Gets the value of the attribute: LATEST. An indicator of whether or not the iteration is the latest one.

Supported API: false

Returns:

boolean

setLatest

protected void setLatest(boolean a_Latest)
                  throws WTPropertyVetoException

Sets the value of the attribute: LATEST. An indicator of whether or not the iteration is the latest one.

Supported API: false

Parameters:

a_Latest -

Throws:

WTPropertyVetoException

getBranchId

public long getBranchId()

Gets the value of the attribute: BRANCH_ID. An identifier that uniquely labels an iteration line (i.e., a branch). It can act as part of a foreign key for query. If the object is not only Iterated but also Versioned this identifier is unique per iteration line. When a new iteration is constructed (the first to exist in an iteration line) this identifier is assigned a value from the POM's OID pool. This ensures that the identifier is unique within the system even compared to the "long" field of any object's OID.

Supported API: false

Returns:

long

setBranchId

protected void setBranchId(long a_BranchId)
                    throws WTPropertyVetoException

Sets the value of the attribute: BRANCH_ID. An identifier that uniquely labels an iteration line (i.e., a branch). It can act as part of a foreign key for query. If the object is not only Iterated but also Versioned this identifier is unique per iteration line. When a new iteration is constructed (the first to exist in an iteration line) this identifier is assigned a value from the POM's OID pool. This ensures that the identifier is unique within the system even compared to the "long" field of any object's OID.

Supported API: false

Parameters:

a_BranchId -

Throws:

WTPropertyVetoException

getIteratedClass

public Class getIteratedClass()

Gets the value of the attribute: ITERATED_CLASS.

Supported API: false

Returns:

Class

setIteratedClass

public void setIteratedClass(Class a_IteratedClass)

Sets the value of the attribute: ITERATED_CLASS.

Supported API: false

Parameters:

a_IteratedClass -

getIdentifier

public IterationIdentifier getIdentifier()

Gets the object for the association that plays role: IDENTIFIER. The iteration's identifier.

Supported API: false

Returns:

IterationIdentifier

setIdentifier

protected void setIdentifier(IterationIdentifier a_Identifier)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: IDENTIFIER. The iteration's identifier.

Supported API: false

Parameters:

a_Identifier -

Throws:

WTPropertyVetoException

identifierValidate

private void identifierValidate(IterationIdentifier a_Identifier)
                         throws WTPropertyVetoException

Parameters:

a_Identifier -

Throws:

WTPropertyVetoException

getModifier

public WTPrincipalReference getModifier()

Gets the object for the association that plays role: MODIFIER. The modifier of the business object (i.e., its iteration).

Supported API: false

Returns:

WTPrincipalReference

setModifier

protected void setModifier(WTPrincipalReference a_Modifier)
                    throws WTPropertyVetoException

Sets the object for the association that plays role: MODIFIER. The modifier of the business object (i.e., its iteration).

Supported API: false

Parameters:

a_Modifier -

Throws:

WTPropertyVetoException

modifierValidate

private void modifierValidate(WTPrincipalReference a_Modifier)
                       throws WTPropertyVetoException

Parameters:

a_Modifier -

Throws:

WTPropertyVetoException

getPredecessor

public ObjectReference getPredecessor()

Gets the object for the association that plays role: PREDECESSOR. The iteration's predecessor.

Supported API: false

Returns:

ObjectReference

setPredecessor

protected void setPredecessor(ObjectReference a_Predecessor)
                       throws WTPropertyVetoException

Sets the object for the association that plays role: PREDECESSOR. The iteration's predecessor.

Supported API: false

Parameters:

a_Predecessor -

Throws:

WTPropertyVetoException

predecessorValidate

private void predecessorValidate(ObjectReference a_Predecessor)
                          throws WTPropertyVetoException

Parameters:

a_Predecessor -

Throws:

WTPropertyVetoException

getState

public IterationState getState()

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

Supported API: false

Returns:

IterationState

setState

public void setState(IterationState a_State)
              throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_State -

Throws:

WTPropertyVetoException

stateValidate

private void stateValidate(IterationState a_State)
                    throws WTPropertyVetoException

Parameters:

a_State -

Throws:

WTPropertyVetoException

getCreator

public WTPrincipalReference getCreator()

Gets the object for the association that plays role: CREATOR. The creator of the Version. (ie first iteration on this branch)

Supported API: false

Returns:

WTPrincipalReference

setCreator

protected void setCreator(WTPrincipalReference a_Creator)
                   throws WTPropertyVetoException

Sets the object for the association that plays role: CREATOR. The creator of the Version. (ie first iteration on this branch)

Supported API: false

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

creatorValidate

private void creatorValidate(WTPrincipalReference a_Creator)
                      throws WTPropertyVetoException

Parameters:

a_Creator -

Throws:

WTPropertyVetoException

getCreatorOrig

public WTPrincipalReference getCreatorOrig()

Gets the value of the attribute: CREATOR. The creator of the very first business object (i.e., its iteration) in the branch. Thus, the creator of the version.

Supported API: false

Returns:

WTPrincipalReference

newIterationInfo

public static IterationInfo newIterationInfo()
                                      throws WTException

Default factory for the class.

Supported API: false

Returns:

IterationInfo

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