dmaClass_VersionSeries

The Version Series Class objects represent collections of versionable objects.

Class ID: dmaClass_VersionSeries
Superclass: Containable

Interfaces

Properties

Name	Impl. Required	System Gen'ed	Read-Only	Value Required	Type	Cardinality	Required Class
OIID	-	Yes	Yes	-	String	Scalar
Class Description	Yes	Yes	Yes	Yes	Object	Scalar	Class Description
This	-	Yes	Yes	Yes	Object	Scalar	Version Series
Create Pending	-	Yes	Yes	Yes	Boolean	Scalar
Update Pending	-	Yes	Yes	Yes	Boolean	Scalar
Delete Pending	-	Yes	Yes	Yes	Boolean	Scalar
Parent	-	Yes	Yes	-	Object	Scalar	Containment Relationship
Parent Container	-	Yes	Yes	-	Object	Scalar	Container
Containers	-	Yes	Yes	-	Object	Enum	Containment Relationship
Configuration History	Yes	-	-	Yes	Object	Scalar	Configuration History
Is Primary Series	Yes	-	-	Yes	Boolean	Scalar
Version Descriptions	Yes	Yes	Yes	-	Object	Enum	Version Description
Current Version Description	Yes	Yes	-	-	Object	Scalar	Version Description
Reservation	Yes	Yes	Yes	-	Object	Scalar	Reservation
Branched From Version Descriptions	-	Yes	Yes	-	Object	Enum	Version Description
Terminated Into Version Descriptions	-	Yes	Yes	-	Object	Enum	Version Description

Detailed Description

The version series is used to represent a collection of versionable objects that are versions of the same conceptual entity. The Version Series are made up of a linear sequence of zero or more Version Description objects and each Version Description object refers to at most one versionable object. The Version Series is part of exactly one Configuration History.

Property Descriptions

• OIID {dmaProp_OIID}
Property Inherited from DMA

• Class Description {dmaProp_ClassDescription}
Property Inherited from DMA

• This {dmaProp_This}
Property Inherited from DMA

• Create Pending {dmaProp_CreatePending}
Property Inherited from DMA

• Update Pending {dmaProp_UpdatePending}
Property Inherited from DMA

• Delete Pending {dmaProp_DeletePending}
Property Inherited from DMA

• Parent {dmaProp_Parent}
Property Inherited from Containable

• Parent Container {dmaProp_ParentContainer}
Property Inherited from Containable

• Containers {dmaProp_Containers}
Property Inherited from Containable

• Configuration History {dmaProp_ConfigurationHistory}

Configuration History associated with this object.

This object is the Configuration history to which this object belongs.

• Is Primary Series {dmaProp_IsPrimarySeries}

This is the Primary Series under the Configuration History.

This property must be set to make this Version Series the Primary Series under the associated Configuration History. At most one Version Series may be primary under a given Configuration History.

• Version Descriptions {dmaProp_VersionDescriptions}

An enumeration of the Version Description objects by which this versionable object is referenced.

This property is only required if versioning is supported. If the object is not part of any version series, the enumeration is empty. Otherwise, it is a system-derived enumeration of those Version Descriptions which denote this object being part of a Version Series. This enumeration is manipulated by the IdmaVersionable::SetCheckIn method.

• Current Version Description {dmaProp_CurrentVersionDescription}

Shortcut to latest description object in the Version Series.

This property is a short-cut to find the latest Version Description in the Version Series. It is normally manipulated only by SetCheckIn, but can be set by direct manipulation if permitted by the implementation. This property is used by the SetCheckOutNext operation to determine what versionable object to clone.

• Reservation {dmaProp_Reservation}

This property contains a Reservation object if there is an outstanding Checkout or Reservation against this Version Series.

This is a system property -- it is manipulated by the SetCheckOutNext, SetReserveNext and SetRevoke methods of the Version Series object, and by the SetCheckIn method of a Versionable object which resolves the reservation.

• Branched From Version Descriptions {dmaProp_BranchedFromVersionDescriptions}

Enumeration of VersionDescriptions from other VersionSeries that this series springs from. Used to start a branch.

This property is an enumeration of Version Descriptions from which this Version Series obtained its first version’s source material. Applications which are DMA 1.0 compliant can safely ignore this property.

• Terminated Into Version Descriptions {dmaProp_TerminatedIntoVersionDescriptions}

Enumeration of Version Descriptions in other Version Series. Used to terminate a branch.

This property is an enumeration of Version Descriptions to which this Version Series contributed its last version’s source material. This property is not used in DMA 1.0 implementations.