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.
EffDisplayProcessorDelegate

Supported API: false

Extendable: false
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.
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.
ProductInstance Deprecated.  
ProductSolution Deprecated.  
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
AddEffFormProcessor

Supported API: false

Extendable: false
AddEffTaskDelegate Deprecated.  
ChangeActivityAddEffActionDelegate

Supported API: false

Extendable: false
ChangeActivityAddEffTaskDelegate

Supported API: false

Extendable: false
ChangeActivityAddEffURLActionDelegate

Supported API: false

Extendable: false
ChangeActivityEffDisplayProcessor

Supported API: false

Extendable: false
ChangeItemViewEffActionDelegate

Supported API: false

Extendable: false
ChangeItemViewEffURLActionDelegate

Supported API: false

Extendable: false
ChangeOrderAddEffActionDelegate

Supported API: false

Extendable: false
ChangeOrderAddEffTaskDelegate

Supported API: false

Extendable: false
ChangeOrderAddEffURLActionDelegate

Supported API: false

Extendable: false
ChangeOrderEffDisplayProcessor

Supported API: false

Extendable: false
ConfigItemInstance The configuration item represented by this instance.
ConfigItemSolution Association used to identify the solution of a configuration item.
DateEffEffConfigurationItem Use the newDateEffEffConfigurationItem static factory method(s), not the DateEffEffConfigurationItem constructor, to construct instances of this class.
DateEffGroupRangeDelegate Range delegate for dates.
DateEffRange A range using Timestamps.
DefaultEffDisplayProcessor

Supported API: false

Extendable: false
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.
DisplayIdentificationProductInstanceDelegate Deprecated.  
EffAuthorization Use the newEffAuthorization static factory method(s), not the EffAuthorization constructor, to construct instances of this class.
EffChangeAudit Object that marks the creation or factual deletion of an Eff object.
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.
EffContextKey The key class to be used by all implementations of EffContext.
EffCreation Use the newEffCreation static factory method(s), not the EffCreation constructor, to construct instances of this class.
EffDeletion Use the newEffDeletion static factory method(s), not the EffDeletion constructor, to construct instances of this class.
EffDisplayProcessorFactory

Supported API: false

Extendable: false
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-").
EffGroup.RangeSet  
EffGroupAssistant Assistant for getting EffGroups, converting EffRanges to and from Strings, and adding the Effs associated to EffManagedVersions to EffGroups.
EffGroupAssistant.Key This implementation class implements a hashable key for an Eff or EffGroup object, based on the intersection of version branch id, context object id, and effectivity type.
EffGroupAssistantEvent Events emitted by the EffGroupAssistant for customization purposes.
EffGroupAttribute  
EffGroupAttribute.Wrapper  
EffHelper This helper is used to access an implementation of EffService via the static reference EffHelper.service.
EffHistoryActionDelegate

Supported API: true

Extendable: false
EffHistoryMap This class is an unmodifiable implementation of the java.util.SortedMap interface for representing a historical sequence of mutually compatible (see EffSet) sets of Eff objects.
EffHistoryProcessor  
EffHistoryTableModel  
EffHistoryTableService  
EffHistoryURLActionDelegate

Supported API: true

Extendable: false
EffModifier Use the newEffModifier static factory method(s), not the EffModifier constructor, to construct instances of this class.
EffServiceFwd 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.
EffSet This class is a modifiable implementation of the java.util.Set interface for storing compatible Eff objects.
EffSet.Element  
EffTemplateProcessor

Supported API: false

Extendable: false
EffVisitor Visitor used to append effectivities to a node.
GroupEffConfigSpec Associates a PersistableEffConfigSpec to its owning container.
IncorporationDateProductInstance Use the newIncorporationDateProductInstance static factory method(s), not the IncorporationDateProductInstance constructor, to construct instances of this class.
LeftFilledStringEffEffContext Use the newLeftFilledStringEffEffContext static factory method(s), not the LeftFilledStringEffEffContext constructor, to construct instances of this class.
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.
PersistableEffConfigSpec Persistent wrapper of an EffConfigSpec (which is ObjectMappable).
ProductInstanceIdentificationObject Deprecated.  
QueryHelper  
SetEffFormProcessor

Supported API: false

Extendable: false
SetEffTaskDelegate

Supported API: false

Extendable: false
StandardEffGroupDisplayIdentity Display identity for effectivity groups.
StandardEffRangesIdentifier Localizable message.
StandardEffService This standard implementation of EffService implements much extra functionality via listeners defined in StandardEffService.performStartupProcess().
StandardProductInstanceDisplayIdentity Deprecated.  
StringEffEffConfigurationItem Use the newStringEffEffConfigurationItem static factory method(s), not the StringEffEffConfigurationItem constructor, to construct instances of this class.
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.
TheProductInstanceSolution Use the newTheProductInstanceSolution static factory method(s), not the TheProductInstanceSolution constructor, to construct instances of this class.
UpdateEffsTask This class encapsulates the logic for updating the effectivity vector of one or more EffManagedVersion objects, recording the history of effectivity changes as appropriate.
UpgradeEffContextKey  
 

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'"