Package wt.vc.baseline

See:
Description

Interface Summary

Baseline	This interface is used to tag a class that represents a Baseline.
Baselineable	This interface is used to tag a class that can be part of a Baseline.
BaselineDelegate	Supported API: false Extendable: false
BaselineService	This service interface defines the service API for recording that a Baselineable belongs to a Baseline by persisting a BaselineMember association.
BaselineSvrService	The BaselineSvrService interface identifies the set of BaselineService methods that are invokable only from classes running in the method server.
IteratedPartialBaseline	An iterated partial baseline is a baseline that stores additions, removals, and replacements (delete/add) incrementally using iterations.
NonStrictBaseline	This interface is used to tag a class that represents a non-strict baseline.

Class Summary

BaselineHelper	This helper for BaselineService provides a standard helper with access via the static reference BaselineHelper.service, but with no helper methods.
BaselineMember	In the PDM Enablers UML, this association is named "Baselined".
BaselineMemberInfo	Deprecated. No longer necessary.
BaselineMemberRIEHandler
BaselineMemberTuple	Use the newBaselineMemberTuple static factory method(s), not the BaselineMemberTuple constructor, to construct instances of this class.
BaselineMemberTupleArrayStatement	Supported API: false Extendable: false
BaselineMemberTupleList	Supported API: false Extendable: false
BaselineOperation	This class encapsulates a Baseline operation.
BaselineRemoveMember	An internal association used to indicate the removal of a member from an iterated partial baseline.
BaselineServiceEvent	This class implements an event for the Baseline service operations.
BaselineServiceFwd	This service interface defines the service API for recording that a Baselineable belongs to a Baseline by persisting a BaselineMember association.
BaselineSvrHelper	Supported API: true Extendable: false
BaselineVisitor	This class implements the Visitor interface.
IteratedPartialBaselineDelegate	Supported API: false Extendable: false
ManagedBaseline	This class is an implementation of a Baseline.
ManagedBaselineIdentity	Provides Identification capabilities for a ManagedBaseline instance.
ManagedBaselineIdentitySeq	Supported API: false Extendable: false
ManagedBaselineKey	Use the newManagedBaselineKey static factory method(s), not the ManagedBaselineKey constructor, to construct instances of this class.
ManagedBaselineStoreListener	Deprecated. Use an initialization rule to automatically assign a number to a baseline.
StandardBaselineDelegate	Supported API: false Extendable: false
StandardBaselineService	This implementation of the BaselineService interface add listeners via StandardBaselineService.performStartupProcess().

Exception Summary

CannotDeleteBaselineMemberException

Supported API: false Extendable: false

Package wt.vc.baseline Description

vc package - Baseline Service

Design Overview

The baseline is a fundamental concept of configuration management. Because PDM business objects are versionable and subject to change, numerous configurations of a product structure will be created over time. Baselines identify and establish the product structure configurations that are of significant interest to the enterprise. As such, baselines represent product structure snapshots that are created by the various organizations of an enterprise for formal as well as informal reasons. Note that Baseline does not provide a general-purpose archiving utility that can reconstruct the state of the system as it existed at a point in time. There are many properties of the system that will not be recorded as part of Baseline, such as the foldering information, life cycle state, and so on.

External Interface

The Baselineable interface provides an abstraction of a plug-and-play component. The intent is that, in an object model, a business object would assert that it is Baselineable by inheriting (that is, it implements) the Baselineable interface. With this assertion, the business object can then be part of a Baseline. The Baselineable interface extends the Iterated interface and, therefore, must play the Iteration role in the Master-Iteration (MI) pattern.

The Baseline interface is asserted for an object that can be associated with Baselineable items. An out-of-the-box ManagedBaseline object implements the Baseline interface and has name, number, and description attributes. It is also Foldered and Life Cycle managed.

The Baseline service provides an abstraction that specifies and promotes serverside functionality as a service that is available remotely for use by a client. The intent is that this interface defines all the necessary server-side functionality for baseline. The BaselineHelper provides an abstraction as the API to the Baseline service.

The Baseline service provides basic APIs for adding and removing Baselineable items. There are also operations for retrieving baseline information. A convenience operation is also provided to automatically populate a Baseline by navigating structured data. As the structure is navigated, each Baselineable item is added to the Baseline. This navigation is customizable and an out-of-the-box implementation is provided for navigating a part structure via the uses relationship.

The BaselineServiceEvent provides an abstraction of a specialized keyed event used by the Baseline service to signal other services that a baseline activity is about to begin or has occurred. This gives other services the opportunity in a plugand- play architecture to act accordingly on these events. Validation, vetoing, and post-processing are typical reactions to events.

Business Rules

The following business rules apply to baseline:

• Adding or removing items from a baseline is equivalent to modifying the Baseline object and is subject to the access control properties of the baseline. For example, if ManagedBaseline object is used, the life cycle state InWork could have access rights set so that any user can modify the object and be able to add or remove items. The Released state could be set so that a normal user does not have modify access rights. This would allow for the concept of a frozen baseline. The baseline would be available for adding and removing items until it was frozen by changing its state to Released.
• A baseline can have zero or more Baselineable objects associated with it, and a Baselineable object can be part of zero or more baselines. However, for a given baseline, only a single iteration of a given master can be part of that baseline.
• Once an iteration has been added to a baseline, that iteration cannot be modified or deleted. Note that other attributes of a Baselineable object that are not specifically related to an iteration can still be modified (for example, life cycle state, folder, master attributes, and so on). This is the normal case for an Iterated object that is RevisionControlled. An object can be modified only if it is checked out.
• For operations that add multiple Baselineable objects to a baseline as a single action (for example, automatic population), the operation is performed as a single transaction.
• A baseline can be used in a ConfigSpec that essentially selects a single iteration of a master item, depending on which iteration is part of the specified baseline. For example, when navigating a product structure (such as, using the Product Information Explorer, generating a BOM, and so on), a Baseline ConfigSpec can be used. During search or navigation, if an item iteration is found by the Baseline ConfigSpec, then it will be returned. Otherwise, it will be considered baseline independent and only the master for that item will be returned. Because it is a master, navigation will not proceed below that object. (See the Configuration Specification section for more information.)
• A baseline business object will be locked when it is edited to support concurrent usage. This is necessary because the Baseline service is responsible for ensuring that only a single iteration for each master is in the baseline. Without locking, if separate clients added different iterations for the same master, it would be possible for both iterations to be added. The Persistence Manager row level locking API is used. The baseline is locked within a transaction to prevent any other operations on that baseline. If some error occurs, then all changes are rolled back and the baseline is automatically unlocked.
• Whenever Baselineable items are added to or removed from a baseline, the modification timestamp is updated on the Baseline object. The contents of a baseline are considered business attributes of the Baseline object. Another desired side effect of the baseline update is that access permissions are checked on the Baseline object. If the user does not have authority to modify the Baseline object, then the entire baseline operation fails.
• There are no restrictions on adding Baselineable items to a baseline. For example, an item in a checked out or personal folder can be added to a baseline. However, this can lead to situations that may be confusing to a user. When viewing a baseline, only those items that the user has access to (that is, in shared folders) are displayed. Another example is if a checked out item is placed in a baseline and then the undo-checkout operation is performed. Undo-checkout deletes the working copy, which will cause the Baseline service to throw an exception (items in a baseline cannot be modified or deleted).

Event Processing

The Baseline service is both a producer and consumer of events. Whenever an item is added, removed, or replaced in a baseline, events are generated prior to and after the operation. For example, adding an item generates PRE_ADD_BASELINE and POST_ADD_BASELINE events. Developers can use the basic event listening mechanism to perform customized actions during baseline operations. The Baseline service listens for the pre-modify, pre-delete, and prepare for modify events to enforce business rules for items that are part of a baseline.