wt.vc
Interface OneOffVersioned

All Superinterfaces:

Iterated, NetFactor, ObjectMappable, Persistable, Serializable, Versionable, Versioned

All Known Subinterfaces:

ConfigurationManageable, ConfiguredVersion

All Known Implementing Classes:

EPMDocument, WTDocument, WTPart, WTProduct

public interface OneOffVersioned

extends Versioned

One-off versions are versions exist out of the normal versioning schemes. For example, if a change needed to be made to a Rev A of some part, and either a Rev B existed or this work is not intended to be mainstreamed, a one-off version of Rev A can be created. This version would be represented as something like Rev A-1. One-off versions can be created from any version, so one-off versions can be created from other one-off versions. One-off versions must, however, have a normal version as a base; that is, a one-off version must either have another one-off version or a normal version as its predecesser. The identifier A-1 is created by combining the version identifier and the one-off version identifier (the one-off version identifier is represented as a number, but can be changed at the site). Note that the one-off identifier is not user assigned, it is assigned at persistence time by taking the highest value for all the one-off versions of a revision. So, if A is one-offed, the result is A-1. If a one-off version of A-1 is created, it'll be A-2. If, subsequently, another one-off is created from A, it'll be labeled A-3.

Supported API: true

Extendable: true

Field Summary

static String	ONE_OFF_VERSION_IDENTIFIER Label for the attribute; Derived attribute for displaying the one-off version identifier in query results.
static String	ONE_OFF_VERSION_INFO Label for the attribute.

Fields inherited from interface wt.vc.Versioned

VERSION_IDENTIFIER, VERSION_INFO

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, MASTER, MASTER_REFERENCE, MODIFIER, MODIFIER_EMAIL, MODIFIER_FULL_NAME, MODIFIER_NAME

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

OneOffVersionIdentifier	getOneOffVersionIdentifier() Gets the value of the attribute: ONE_OFF_VERSION_IDENTIFIER.
OneOffVersionInfo	getOneOffVersionInfo() Gets the object for the association that plays role: ONE_OFF_VERSION_INFO.
void	setOneOffVersionInfo(OneOffVersionInfo a_OneOffVersionInfo) Sets the object for the association that plays role: ONE_OFF_VERSION_INFO.

Methods inherited from interface wt.vc.Versioned

getVersionIdentifier, getVersionInfo, setVersionInfo

Methods inherited from interface wt.vc.Iterated

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

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

Field Detail

ONE_OFF_VERSION_IDENTIFIER

public static final String ONE_OFF_VERSION_IDENTIFIER

Label for the attribute; Derived attribute for displaying the one-off version identifier in query results.

Supported API: false

See Also:

Constant Field Values

ONE_OFF_VERSION_INFO

public static final String ONE_OFF_VERSION_INFO

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

Method Detail

getOneOffVersionIdentifier

public OneOffVersionIdentifier getOneOffVersionIdentifier()

Gets the value of the attribute: ONE_OFF_VERSION_IDENTIFIER. Derived attribute for displaying the one-off version identifier in query results.

Supported API: false

Returns:

OneOffVersionIdentifier

getOneOffVersionInfo

public OneOffVersionInfo getOneOffVersionInfo()

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

Supported API: false

Returns:

OneOffVersionInfo

setOneOffVersionInfo

public void setOneOffVersionInfo(OneOffVersionInfo a_OneOffVersionInfo)
                          throws WTPropertyVetoException

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

Supported API: false

Parameters:

a_OneOffVersionInfo -

Throws:

WTPropertyVetoException