wt.vc
Interface Iterated

All Superinterfaces:

NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

AdHocStringVersioned, Baselineable, BaselineConfigurationVersion, Changeable2, CombinedPathOccurrenceData, Configuration, ConfigurationManageable, ConfiguredVersion, EffManagedVersion, EPMFamilyTable, Genericizable, IteratedFoldered, IteratedLifeCycleManaged, IteratedPartialBaseline, MPMCompatible, OneOffVersioned, OrganizationOwnedVersion, PathOccurrenceContext, PathOccurrenceData, SerialNumberedBaselineConfigurationVersion, SerialNumberedComponentVersion, SerialNumberedConfiguredInstanceVersion, SerialNumberedInstanceVersion, SessionEditedIteration, Versionable, Versioned, ViewManageable, Workable

All Known Implementing Classes:

AbsCollectionCriteria, AnalysisActivity, BaselineConfigurationOverride, ChangeActivity2, ChangeAnalysis, ChangeInvestigation, ChangeIssue, ChangeOrder2, ChangeProposal, ChangeRequest2, CombinedPathOccurrenceDocumentation, CombinedPathOccurrenceUserIBAs, DefaultWTContainerTemplate, EPMDocument, EPMSepFamilyTable, InstanceReplacementRecord, IteratedFolderResident, ManufacturerPart, MPMMfgProcess, MPMMfgStandardGroup, MPMOperation, MPMPlant, MPMProcessPlan, MPMResource, MPMResourceGroup, MPMSequence, PathOccurrenceDocumentation, PathOccurrenceUserIBAs, ProxyDocument, RevisionControlled, SerialNumberMapping, SupplierPart, VariantSpec, VendorPart, VersionableChangeItem, WTAnalysisActivity, WTChangeActivity2, WTChangeInvestigation, WTChangeIssue, WTChangeOrder2, WTChangeProposal, WTChangeRequest2, WTDocument, WTPart, WTProductConfiguration, WTProductInstance2, WTVariance

public interface Iterated
extends Persistable

Provides an abstraction of a plug-and-play component in conjunction with the Mastered interface. The intent is that in a business model an object would assert that it is an iteration (instance) by inheriting the Iterated interface. With this assertion the business object can then be incremented to new iterations through the iterating service's API, provided it has a master. The business object must assert itself as being a kind of Iterated object in order for it to be incremented, or checked in/out. But if an object is only Iterated and not Workable then it cannot be checked in/out.

Supported API: true

Extendable: true

See Also:

Mastered, VersionControlHelper, VersionControlHelper.service

Field Summary

static String	CONTROL_BRANCH Label for the attribute; Derived attribute for displaying the Control Branch in query results.
static String	CREATOR_EMAIL Label for the attribute; Derived attribute for displaying the iteration creator's E-Mail address in query results.
static String	CREATOR_FULL_NAME Label for the attribute; Derived attribute for displaying the iteration creator's fullname in query results.
static String	CREATOR_NAME Label for the attribute; Derived attribute for displaying the iteration creator's name in query results.
static String	ITERATION_IDENTIFIER Label for the attribute; Derived attribute for displaying the iteration identifier in query results.
static String	ITERATION_NOTE Label for the attribute; Derived attribute for displaying the iteration's note in query results.
static String	LATEST_ITERATION Label for the attribute; Derived attribute for displaying the iteration "latest" flag in query results.
static String	MASTER Label for the attribute; The master for an iteration.
static String	MASTER_REFERENCE Label for the attribute; The master for an iteration.
static String	MODIFIER Label for the attribute; Derived attribute for displaying the iteration's modifier in query results.
static String	MODIFIER_EMAIL Label for the attribute; Derived attribute for displaying the iteration modifier's E-Mail address in query results.
static String	MODIFIER_FULL_NAME Label for the attribute; Derived attribute for displaying the iteration modifier's fullname in query results.
static String	MODIFIER_NAME Label for the attribute; Derived attribute for displaying the iteration modifier's name in query results.

Method Summary

wt.vc.ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
String	getCreatorEMail() Gets the value of the attribute: CREATOR_EMAIL.
String	getCreatorFullName() Gets the value of the attribute: CREATOR_FULL_NAME.
String	getCreatorName() Gets the value of the attribute: CREATOR_NAME.
IterationIdentifier	getIterationIdentifier() Gets the value of the attribute: ITERATION_IDENTIFIER.
String	getIterationNote() Gets the value of the attribute: ITERATION_NOTE.
Mastered	getMaster() Gets the object for the association that plays role: MASTER.
ObjectReference	getMasterReference() Gets the value of the attribute: MASTER_REFERENCE.
WTPrincipalReference	getModifier() Gets the value of the attribute: MODIFIER.
String	getModifierEMail() Gets the value of the attribute: MODIFIER_EMAIL.
String	getModifierFullName() Gets the value of the attribute: MODIFIER_FULL_NAME.
String	getModifierName() Gets the value of the attribute: MODIFIER_NAME.
boolean	isLatestIteration() Gets the value of the attribute: LATEST_ITERATION.
void	setControlBranch(wt.vc.ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
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.

Field Detail

ITERATION_NOTE

static final String ITERATION_NOTE

Label for the attribute; Derived attribute for displaying the iteration's note in query results.

Supported API: true

See Also:

Constant Field Values

CREATOR_EMAIL

static final String CREATOR_EMAIL

Label for the attribute; Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: true

See Also:

Constant Field Values

CREATOR_NAME

static final String CREATOR_NAME

Label for the attribute; Derived attribute for displaying the iteration creator's name in query results.

Supported API: true

See Also:

Constant Field Values

CREATOR_FULL_NAME

static final String CREATOR_FULL_NAME

Label for the attribute; Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: true

See Also:

Constant Field Values

MODIFIER

static final String MODIFIER

Label for the attribute; Derived attribute for displaying the iteration's modifier in query results.

Supported API: true

See Also:

Constant Field Values

MODIFIER_EMAIL

static final String MODIFIER_EMAIL

Label for the attribute; Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: true

See Also:

Constant Field Values

MODIFIER_NAME

static final String MODIFIER_NAME

Label for the attribute; Derived attribute for displaying the iteration modifier's name in query results.

Supported API: true

See Also:

Constant Field Values

MODIFIER_FULL_NAME

static final String MODIFIER_FULL_NAME

Label for the attribute; Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: true

See Also:

Constant Field Values

ITERATION_IDENTIFIER

static final String ITERATION_IDENTIFIER

Label for the attribute; Derived attribute for displaying the iteration identifier in query results.

Supported API: true

See Also:

Constant Field Values

LATEST_ITERATION

static final String LATEST_ITERATION

Label for the attribute; Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: true

See Also:

Constant Field Values

CONTROL_BRANCH

static final String CONTROL_BRANCH

Label for the attribute; Derived attribute for displaying the Control Branch in query results.

Supported API: true

See Also:

Constant Field Values

MASTER

static final String MASTER

Label for the attribute; The master for an iteration. A master must exist for any iteration.

Supported API: true

See Also:

Mastered, Constant Field Values

MASTER_REFERENCE

static final String MASTER_REFERENCE

Label for the attribute; The master for an iteration. A master must exist for any iteration.

Supported API: true

See Also:

Mastered, Constant Field Values

Method Detail

getIterationNote

String getIterationNote()

Gets the value of the attribute: ITERATION_NOTE. Derived attribute for displaying the iteration's note in query results.

Supported API: true

Returns:

String

getCreatorEMail

String getCreatorEMail()

Gets the value of the attribute: CREATOR_EMAIL. Derived attribute for displaying the iteration creator's E-Mail address in query results.

Supported API: true

Returns:

String

getCreatorName

String getCreatorName()

Gets the value of the attribute: CREATOR_NAME. Derived attribute for displaying the iteration creator's name in query results.

Supported API: true

Returns:

String

getCreatorFullName

String getCreatorFullName()

Gets the value of the attribute: CREATOR_FULL_NAME. Derived attribute for displaying the iteration creator's fullname in query results.

Supported API: true

Returns:

String

getModifier

WTPrincipalReference getModifier()

Gets the value of the attribute: MODIFIER. Derived attribute for displaying the iteration's modifier in query results.

Supported API: true

Returns:

WTPrincipalReference

getModifierEMail

String getModifierEMail()

Gets the value of the attribute: MODIFIER_EMAIL. Derived attribute for displaying the iteration modifier's E-Mail address in query results.

Supported API: true

Returns:

String

getModifierName

String getModifierName()

Gets the value of the attribute: MODIFIER_NAME. Derived attribute for displaying the iteration modifier's name in query results.

Supported API: true

Returns:

String

getModifierFullName

String getModifierFullName()

Gets the value of the attribute: MODIFIER_FULL_NAME. Derived attribute for displaying the iteration modifier's fullname in query results.

Supported API: true

Returns:

String

getIterationIdentifier

IterationIdentifier getIterationIdentifier()

Gets the value of the attribute: ITERATION_IDENTIFIER. Derived attribute for displaying the iteration identifier in query results.

Supported API: true

Returns:

IterationIdentifier

isLatestIteration

boolean isLatestIteration()

Gets the value of the attribute: LATEST_ITERATION. Derived attribute for displaying the iteration "latest" flag in query results.

Supported API: true

Returns:

boolean

getControlBranch

wt.vc.ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH. Derived attribute for displaying the Control Branch in query results.

Supported API: true

Returns:

ControlBranch

setControlBranch

void setControlBranch(wt.vc.ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH. Derived attribute for displaying the Control Branch in query results.

Supported API: true

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getMaster

Mastered getMaster()

Gets the object for the association that plays role: MASTER. The master for an iteration. A master must exist for any iteration.

Supported API: true

Returns:

Mastered

See Also:

Mastered

setMaster

void setMaster(Mastered a_Master)
               throws WTPropertyVetoException,
                      WTException

Sets the object for the association that plays role: MASTER. The master for an iteration. A master must exist for any iteration.

Supported API: true

Parameters:

a_Master -

Throws:

WTPropertyVetoException

WTException

See Also:

Mastered

getMasterReference

ObjectReference getMasterReference()

Gets the value of the attribute: MASTER_REFERENCE. The master for an iteration. A master must exist for any iteration.

Supported API: true

Returns:

ObjectReference

See Also:

Mastered

setMasterReference

void setMasterReference(ObjectReference a_MasterReference)
                        throws WTPropertyVetoException

Sets the value of the attribute: MASTER_REFERENCE. The master for an iteration. A master must exist for any iteration.

Supported API: true

Parameters:

a_MasterReference -

Throws:

WTPropertyVetoException

See Also:

Mastered