wt.configuration
Interface SerialNumberedInstanceVersion

All Superinterfaces:

Iterated, NetFactor, ObjectMappable, Persistable, Serializable, SerialNumberedInstanceImpl, Versionable

All Known Subinterfaces:

SerialNumberedConfiguredInstanceVersion

All Known Implementing Classes:

WTProductInstance2

public interface SerialNumberedInstanceVersion
extends SerialNumberedInstanceImpl, Versionable

A version of an instance. Because this instance (as a version) can change over time, it has a notion of incorporation, represented as planned and actual incorporations. The planned incorporation is the time this version is planned to reflect the actual configuration of the instance; the actual incorporation reflects when this actually occurs.

Supported API: true

Extendable: true

See Also:

SerialNumberedInstanceMaster, SerialNumberedConfiguredInstanceVersion, WTProductInstance2

Field Summary

static String	INCORPORATED Label for the attribute; The date this version actually reflects the configuration of the serial numbered instance it represents.
static String	INCORPORATED_AS_STRING Label for the attribute; When a successor version is incorporated, its predecessor's incorporation is effectively ended.
static String	LOT_NUMBER Label for the attribute; The serial number of the master.
static String	MASTER Label for the attribute.
static String	MASTER_REFERENCE Label for the attribute.
static String	PLANNED_INCORPORATION Label for the attribute; The date this version is planned to reflect the current configuration of the serial numbered instance it represents.
static String	SERIAL_NUMBER Label for the attribute; The serial number of the master.

Fields inherited from interface wt.configuration.SerialNumberedInstanceImpl

CONFIGURATION, CONFIGURATION_REFERENCE

Fields inherited from interface wt.vc.Iterated

CONTROL_BRANCH, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_NOTE, LATEST_ITERATION, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Method Summary

Timestamp	getIncorporated() Gets the value of the attribute: INCORPORATED.
String	getIncorporatedAsString() Gets the value of the attribute: INCORPORATED_AS_STRING.
String	getLotNumber() Gets the value of the attribute: LOT_NUMBER.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
Timestamp	getPlannedIncorporation() Gets the value of the attribute: PLANNED_INCORPORATION.
String	getSerialNumber() Gets the value of the attribute: SERIAL_NUMBER.
Persistable	getSerialNumberedInstanceOf() Returns Persistable associated with the instance.
void	setIncorporated(Timestamp a_Incorporated) Sets the value of the attribute: INCORPORATED.
void	setLotNumber(String a_LotNumber) Sets the value of the attribute: LOT_NUMBER.
void	setMaster(Mastered a_Master) Sets the object for the association that plays role: MASTER.
void	setMasterReference(ObjectReference a_MasterReference) Sets the value of the attribute: MASTER_REFERENCE.
void	setPlannedIncorporation(Timestamp a_PlannedIncorporation) Sets the value of the attribute: PLANNED_INCORPORATION.
void	setSerialNumber(String a_SerialNumber) Sets the value of the attribute: SERIAL_NUMBER.

Methods inherited from interface wt.configuration.SerialNumberedInstanceImpl

getConfiguration, getConfigurationReference, setConfiguration, setConfigurationReference

Methods inherited from interface wt.vc.Iterated

getControlBranch, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationNote, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch

Field Detail

SERIAL_NUMBER

static final String SERIAL_NUMBER

Label for the attribute; The serial number of the master.

Supported API: true

See Also:

Constant Field Values

LOT_NUMBER

static final String LOT_NUMBER

Label for the attribute; The serial number of the master.

Supported API: true

See Also:

Constant Field Values

PLANNED_INCORPORATION

static final String PLANNED_INCORPORATION

Label for the attribute; The date this version is planned to reflect the current configuration of the serial numbered instance it represents.

Supported API: true

See Also:

Constant Field Values

INCORPORATED

static final String INCORPORATED

Label for the attribute; The date this version actually reflects the configuration of the serial numbered instance it represents. Use incorporatedAsStriing to display this value, as it will display the incorporation range.

Supported API: true

See Also:

Constant Field Values

INCORPORATED_AS_STRING

static final String INCORPORATED_AS_STRING

Label for the attribute; When a successor version is incorporated, its predecessor's incorporation is effectively ended. This attribute displays the incorporation as this range, so it's easier for a user to determine the actual date range this version was incorporated. If Rev A were incorporated at time X and Rev B at time Y, this attribute would return X-Y for Rev A and Y- for Rev B.

Supported API: true

See Also:

Constant Field Values

MASTER

static final String MASTER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

MASTER_REFERENCE

static final String MASTER_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getSerialNumber

String getSerialNumber()

Gets the value of the attribute: SERIAL_NUMBER. The serial number of the master.

Supported API: true

Specified by:

getSerialNumber in interface SerialNumberedInstanceImpl

Returns:

String

setSerialNumber

void setSerialNumber(String a_SerialNumber)
                     throws WTPropertyVetoException

Sets the value of the attribute: SERIAL_NUMBER. The serial number of the master.

Supported API: true

Specified by:

setSerialNumber in interface SerialNumberedInstanceImpl

Parameters:

a_SerialNumber -

Throws:

WTPropertyVetoException

getLotNumber

String getLotNumber()

Gets the value of the attribute: LOT_NUMBER. The serial number of the master.

Supported API: true

Specified by:

getLotNumber in interface SerialNumberedInstanceImpl

Returns:

String

setLotNumber

void setLotNumber(String a_LotNumber)
                  throws WTPropertyVetoException

Sets the value of the attribute: LOT_NUMBER. The serial number of the master.

Supported API: true

Specified by:

setLotNumber in interface SerialNumberedInstanceImpl

Parameters:

a_LotNumber -

Throws:

WTPropertyVetoException

getPlannedIncorporation

Timestamp getPlannedIncorporation()

Gets the value of the attribute: PLANNED_INCORPORATION. The date this version is planned to reflect the current configuration of the serial numbered instance it represents.

Supported API: true

Returns:

Timestamp

setPlannedIncorporation

void setPlannedIncorporation(Timestamp a_PlannedIncorporation)
                             throws WTPropertyVetoException

Sets the value of the attribute: PLANNED_INCORPORATION. The date this version is planned to reflect the current configuration of the serial numbered instance it represents.

Supported API: true

Parameters:

a_PlannedIncorporation -

Throws:

WTPropertyVetoException

getIncorporated

Timestamp getIncorporated()

Gets the value of the attribute: INCORPORATED. The date this version actually reflects the configuration of the serial numbered instance it represents. Use incorporatedAsStriing to display this value, as it will display the incorporation range.

Supported API: true

Returns:

Timestamp

setIncorporated

void setIncorporated(Timestamp a_Incorporated)
                     throws WTPropertyVetoException

Sets the value of the attribute: INCORPORATED. The date this version actually reflects the configuration of the serial numbered instance it represents. Use incorporatedAsStriing to display this value, as it will display the incorporation range.

Supported API: true

Parameters:

a_Incorporated -

Throws:

WTPropertyVetoException

getIncorporatedAsString

String getIncorporatedAsString()

Gets the value of the attribute: INCORPORATED_AS_STRING. When a successor version is incorporated, its predecessor's incorporation is effectively ended. This attribute displays the incorporation as this range, so it's easier for a user to determine the actual date range this version was incorporated. If Rev A were incorporated at time X and Rev B at time Y, this attribute would return X-Y for Rev A and Y- for Rev B.

Supported API: true

Returns:

String

getMaster

Mastered getMaster()

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

Supported API: true

Specified by:

getMaster in interface Iterated

Returns:

Mastered

See Also:

Mastered

setMaster

void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

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

Supported API: true

Specified by:

setMaster in interface Iterated

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

getMasterReference in interface Iterated

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE.

Supported API: true

Specified by:

setMasterReference in interface Iterated

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered

getSerialNumberedInstanceOf

Persistable getSerialNumberedInstanceOf()
                                        throws WTException

Returns Persistable associated with the instance.

Supported API: true

Throws:

WTException