Package wt.eff

Provides generic base effectivity functionality via EffService, EffConfigSpecAssistant and EffGroupAssistant to assert that a PDM object is effective under certain conditions; an out-of-the-box reference implementation of this base functionality is defined by wt.effectivity.

See:
          Description

Interface Summary
DateEff An Eff based on an EffContext and a date range.
Eff Provides the capability to specify when an EffManagedVersion is effective given a start and end (EffRange) and optionally an EffContext.
EffConfigurationItem A configuration item that serves as the context for which an Eff is valid.
EffContext The context (ProductInstance or EffConfigurationItem) under which an Eff operates, the EffContext may be a configuration item, as recognized by PDM Enablers, for example.
EffGroupRangeDelegate Delegate used by the EffGroupAssistant to convert between an EffRange and start/end pairs.
EffManagedVersion This Versioned object can have Effs assigned to it; often the Effs are grouped into one EffGroup.
EffRange The range of values (from start to end) under which an Eff is valid; the start value is required, and indicates when the Eff becomes valid, but the end value is optional, and when non-null signifies when an Eff is no longer valid.
EffRecord

Supported API: true

Extendable: false
EffRecordable

Supported API: true

Extendable: false
EffService This service provides general effectivity functionality, both through its API and through listeners, that operate on EffManagedVersion, Eff, EffContext, EffConfigurationItem, ProductSolution and ProductInstance objects; this functionality can be reused by various implementations of effectivity including the reference implementation in wt.effectivity.
IncorporationDate Effectivities are no longer used to indicate incorporation.
LeftFilledStringEff An Eff based on an EffContext and a LeftFilledStringEffRange.
PendingDateEff

Supported API: true

Extendable: false
PendingEff PendingEff is the parent interface for all pending effectivity classes.
PendingStringEff

Supported API: true

Extendable: false
StringEff An Eff based on an EffConfigurationItem and a StringEffRange.
ValidEffsDelegate Delegate used to determine the valid Eff classes based on an EffContext object.
 

Class Summary
ChangeRecordPendingEff Use the newChangeRecordPendingEff static factory method(s), not the ChangeRecordPendingEff constructor, to construct instances of this class.
ClientEffGroup A lightweight representation of EffGroup for use by the client.



Supported API: true

Extendable: false

DateEffGroupRangeDelegate Range delegate for dates.
DateEffRange A range using Timestamps.
DefaultValidEffsDelegate Default delegate, using introspection to determine the valid Eff classes.
DisplayIdentificationEffConfigurationItemDelegate Delegate for displaying a configuration item.
DisplayIdentificationEffGroupDelegate Delegate for displaying an effectivity group.
EffConfigSpec A primitive config spec used to filter based on an Eff, its EffContext and a value for which the EffManagedVersion should be effective.
EffConfigSpecAssistant Assistant for handling type conversions for the start and end values of any subclass of of an EffRange, and providing client and server-side APIs useful for EffConfigSpec, PersistableEffConfigSpec and EffConfigSpecGroup.
EffConfigSpecGroup A container config spec allowing multiple PersistableEffConfigSpecs to be considered.
EffConfigurationItemIdentificationObject The identification object to be used by all implementations of configuration item.
EffDeletion Use the newEffDeletion static factory method(s), not the EffDeletion constructor, to construct instances of this class.
EffEffContext Foreign-key association between an Eff and its context.
EffGroup An in-memory-only object used to encapsulate all the Effs associated with a given EffManagedVersion and EffContext for client interaction purposes (for example, if three effectivities exist for configuration item X and part 100 Rev A, these three effectivities will be represented as a range like "1-10, 12, 20-").
EffGroupAssistant Assistant for getting EffGroups, converting EffRanges to and from Strings, and adding the Effs associated to EffManagedVersions to EffGroups.
EffGroupAssistantEvent Events emitted by the EffGroupAssistant for customization purposes.
EffHelper This helper is used to access an implementation of EffService via the static reference EffHelper.service.
EffHistoryActionDelegate

Supported API: true

Extendable: false
EffHistoryURLActionDelegate

Supported API: true

Extendable: false
EffServiceEvent Event class for StandardEffService.
EffTypeModifier

Supported API: true

Extendable: false
EffVisitor Visitor used to append effectivities to a node.
LeftFilledStringEffGroupRangeDelegate Range delegate for left-filled strings.
LeftFilledStringEffRange A range that left-fills the start/end values with spaces to ensure that 9 < 10, for example, in a query.
PendingBlockEffectivity Use the newPendingBlockEffectivity static factory method(s), not the PendingBlockEffectivity constructor, to construct instances of this class.
PendingDateEffectivity Use the newPendingDateEffectivity static factory method(s), not the PendingDateEffectivity constructor, to construct instances of this class.
PendingLotNumberEffectivity Use the newPendingLotNumberEffectivity static factory method(s), not the PendingLotNumberEffectivity constructor, to construct instances of this class.
PendingMSNEffectivity Use the newPendingMSNEffectivity static factory method(s), not the PendingMSNEffectivity constructor, to construct instances of this class.
PendingSerialNumberEffectivity Use the newPendingSerialNumberEffectivity static factory method(s), not the PendingSerialNumberEffectivity constructor, to construct instances of this class.
PersistableEffConfigSpec Persistent wrapper of an EffConfigSpec (which is ObjectMappable).
PropagationOptions A class to hold propagation options for the assignment of the pending effectivity to true effectivity.
StandardEffGroupDisplayIdentity Display identity for effectivity groups.
StandardEffService This standard implementation of EffService implements much extra functionality via listeners defined in StandardEffService.performStartupProcess().
StringEffGroupRangeDelegate Range delegate for strings.
StringEffRange A range using Strings which are not left filled.
TargetEff Use the newTargetEff static factory method(s), not the TargetEff constructor, to construct instances of this class.
 

Exception Summary
EffGroupException

Supported API: true

Extendable: false
 

Package wt.eff Description

Provides generic base effectivity functionality via EffService, EffConfigSpecAssistant and EffGroupAssistant to assert that a PDM object is effective under certain conditions; an out-of-the-box reference implementation of this base functionality is defined by wt.effectivity.

When manufacturing a product it is necessary to specify which versions of parts are used to produce the product. From the standpoint of a version we say that the version is effective in some context (usually the specific product being manufactured) when manufactured within a specific range of dates, serial numbers or lot numbers. Often a configuration specification is used to simplify retrieving all the versions that are needed for a product.

Key classes classes from this package implementing the concept of effectivity:

This package is based in part on the PdmEffectivity section (2.8) of the PDM Enablers specification.

Since:
4.0
See Also:
"'Effectivity Package' in 'Application Developer's Guide'"