wt.vc
Interface Iterated

All Superinterfaces:

NetFactor, ObjectMappable, Persistable, Serializable

All Known Subinterfaces:

AdHocStringVersioned, Baselineable, BaselineConfigurationVersion, BasicTransferUnit, Changeable2, CombinedPathOccurrenceData, Configuration, ConfigurationManageable, ConfiguredVersion, EffectivityManageable, EffManagedVersion, IteratedFoldered, IteratedLifeCycleManaged, IteratedPartialBaseline, IteratedSubjectOfForum, IteratedSubjectOfNotebook, OneOffVersioned, OrganizationOwnedVersion, PathOccurrenceContext, PathOccurrenceData, Promotable, SerialNumberedBaselineConfigurationVersion, SerialNumberedComponentVersion, SerialNumberedConfiguredInstanceVersion, SerialNumberedInstanceVersion, SessionEditedIteration, TransferUnit, TypeDefinition, Versionable, Versioned, ViewManageable, Workable

All Known Implementing Classes:

BaseCriterionDef, BaselineConfigurationOverride, CombinedPathOccurrenceDocumentation, CombinedPathOccurrenceUserIBAs, DefaultWTContainerTemplate, EPMCheckpoint, EPMDocument, ExportObjectGraph, ImportObjectGraph, IteratedFolderResident, PathOccurrenceDocumentation, PathOccurrenceUserIBAs, RevisionControlled, SerialNumberMapping, WfProcessTemplate, WTDocument, WTPart, WTProduct, WTProductConfiguration, WTProductInstance2, WTSerialNumberedPart, WTTypeDefinition

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	BRANCH_IDENTIFIER Label for the attribute; Derived attribute for displaying the iteration's branch identifier in query results.
static String	CONTROL_BRANCH Label for the attribute.
static String	CREATOR Label for the attribute; Derived attribute for displaying the Version Creator.
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_INFO Label for the attribute; The iteration cookie aggregated in any business object that asserts itself as being iterated.
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.

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Method Summary

long	getBranchIdentifier() Gets the value of the attribute: BRANCH_IDENTIFIER.
ControlBranch	getControlBranch() Gets the value of the attribute: CONTROL_BRANCH.
WTPrincipalReference	getCreator() Gets the value of the attribute: CREATOR.
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.
IterationInfo	getIterationInfo() Gets the object for the association that plays role: ITERATION_INFO.
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(ControlBranch a_ControlBranch) Sets the value of the attribute: CONTROL_BRANCH.
void	setIterationInfo(IterationInfo a_IterationInfo) Sets the object for the association that plays role: ITERATION_INFO.
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.

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

ITERATION_NOTE

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

BRANCH_IDENTIFIER

public static final String BRANCH_IDENTIFIER

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

Supported API: false

See Also:

Constant Field Values

LATEST_ITERATION

public 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

CREATOR

public static final String CREATOR

Label for the attribute; Derived attribute for displaying the Version Creator. Will be the same for each iteration of a Version. A Version corresponds to all iterations for a given branchId

Supported API: false

See Also:

Constant Field Values

CONTROL_BRANCH

public static final String CONTROL_BRANCH

Label for the attribute.

Supported API: true

See Also:

Constant Field Values

ITERATION_INFO

public static final String ITERATION_INFO

Label for the attribute; The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

See Also:

IterationInfo, Constant Field Values

MASTER

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

public 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

getBranchIdentifier

public long getBranchIdentifier()

Gets the value of the attribute: BRANCH_IDENTIFIER. Derived attribute for displaying the iteration's branch identifier in query results.

Supported API: false

Returns:

long

isLatestIteration

public 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

getCreator

public WTPrincipalReference getCreator()

Gets the value of the attribute: CREATOR. Derived attribute for displaying the Version Creator. Will be the same for each iteration of a Version. A Version corresponds to all iterations for a given branchId

Supported API: false

Returns:

WTPrincipalReference

getControlBranch

public ControlBranch getControlBranch()

Gets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Returns:

ControlBranch

setControlBranch

public void setControlBranch(ControlBranch a_ControlBranch)
                      throws WTPropertyVetoException

Sets the value of the attribute: CONTROL_BRANCH.

Supported API: true

Parameters:

a_ControlBranch -

Throws:

WTPropertyVetoException

getIterationInfo

public IterationInfo getIterationInfo()

Gets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Returns:

IterationInfo

See Also:

IterationInfo

setIterationInfo

public void setIterationInfo(IterationInfo a_IterationInfo)
                      throws WTPropertyVetoException

Sets the object for the association that plays role: ITERATION_INFO. The iteration cookie aggregated in any business object that asserts itself as being iterated.

Supported API: false

Parameters:

a_IterationInfo -

Throws:

WTPropertyVetoException

See Also:

IterationInfo

getMaster

public 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

public 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

public 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

public 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