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	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.
static String	UN_INCORPORATED Label for the attribute.

Fields inherited from interface wt.configuration.SerialNumberedInstanceImpl

CONFIGURATION, CONFIGURATION_REFERENCE

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.vc.Iterated

BRANCH_IDENTIFIER, CONTROL_BRANCH, CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME, ITERATION_IDENTIFIER, ITERATION_INFO, 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.
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.
Timestamp	getUnIncorporated() Gets the value of the attribute: UN_INCORPORATED.
void	setIncorporated(Timestamp a_Incorporated) Sets the value of the attribute: INCORPORATED.
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.
void	setUnIncorporated(Timestamp a_UnIncorporated) Sets the value of the attribute: UN_INCORPORATED.

Methods inherited from interface wt.configuration.SerialNumberedInstanceImpl

getConfiguration, getConfigurationReference, setConfiguration, setConfigurationReference

Methods inherited from interface wt.fc.Persistable

checkAttributes, getIdentity, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.ObjectMappable

readExternal, writeExternal

Methods inherited from interface wt.fc.NetFactor

getClassInfo, getConceptualClassname

Methods inherited from interface wt.vc.Iterated

getBranchIdentifier, getControlBranch, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getIterationIdentifier, getIterationInfo, getIterationNote, getModifier, getModifierEMail, getModifierFullName, getModifierName, isLatestIteration, setControlBranch, setIterationInfo

Field Detail

SERIAL_NUMBER

public static final String SERIAL_NUMBER

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

Supported API: true

See Also:

Constant Field Values

PLANNED_INCORPORATION

public 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

public 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

UN_INCORPORATED

public static final String UN_INCORPORATED

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

INCORPORATED_AS_STRING

public 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

public static final String MASTER

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

MASTER_REFERENCE

public static final String MASTER_REFERENCE

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

Method Detail

getSerialNumber

public 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

public 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

getPlannedIncorporation

public 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

public 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

public 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

public 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

getUnIncorporated

public Timestamp getUnIncorporated()

Gets the value of the attribute: UN_INCORPORATED.

Supported API: false

Returns:

Timestamp

setUnIncorporated

public void setUnIncorporated(Timestamp a_UnIncorporated)
                       throws WTPropertyVetoException

Sets the value of the attribute: UN_INCORPORATED.

Supported API: false

Parameters:

a_UnIncorporated -

Throws:

WTPropertyVetoException

getIncorporatedAsString

public 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

public 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

public 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

public 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

public 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