Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
 PREV PACKAGE   NEXT PACKAGE FRAMES    NO FRAMES    

Package wt.occurrence

Defines the capability to uniquely distinguish one occurrence of an object within some complex structure from another occurrence of that same object within the same structure using OccurrenceService.

See:
          Description

Interface Summary
CombinedOccurrence This PathParentableOccurrence allows the combination of PathOccurrences.
CombinedPathOccurrenceData This tagging interface is associated with a CombinedPathOccurrence largely to allow external applications to easily add application-specifc information in a relatively transparent and extensible manner.
DocumentationOccurrenceData This OccurrenceData links a Occurrence to a specific version of a WTDocument.
Occurrence This identifies a unique instance of an object (within some context) in a data structure of BinaryLinks; it has associated OccurrenceData and that data is linked using the dataIdentifier instead of the normal OID; that identifier is generated when an Occurrence is newly created, but then it is preserved when Occurrences are copied forward in response to an OccurrenceableLink being copied forward.
OccurrenceableLink A Link which has associated UsesOccurrences.
OccurrenceableLinkModificationDelegate Determines if you can modify an OccurrenceableLink, since for some links (in particular those with a quantity) a modification might invalidate associated UsesOccurrence objects.
OccurrenceableLinkTerminationDelegate

Supported API: true

Extendable: true
OccurrenceData This tagging interface is associated with an Occurrence largely to allow external applications to easily add application-specifc information in a relatively transparent and extensible manner.
OccurrenceDataCopyDelegate This delegate either copies data forward or does not copy it.
OccurrenceDataMultiplicityDelegate This delegate interface specifies a family of delegates that determine how many OccurrenceData, UsesOccurrenceData or PathOccurrenceData objects may be created of a particular type.
OccurrenceModificationDelegate Determines if you can modify an Occurrence, which may involve checking access rights to the Occurrence or some related object (frequently an OccurrenceableLink or a PathOccurrenceContext.
OccurrenceNameValidationDelegate Checks an Occurrence to see if the name is valid, including a check for uniqueness within its context (except we allow duplicates with null names).
OccurrenceService This service interface defines the API for managing UsesOccurrences, PathOccurrences, CombinedPathOccurrences, UsesOccurrenceData, PathOccurrenceData and CombinedPathOccurrenceData in the context of OccurrenceableLinks, PathOccurrenceContexts and CombinedPathOccurrenceContexts Cookie: None Helper: OccurrenceHelper has helper methods Service implementation: StandardOccurrenceService has listeners ServiceEvent: OccurrenceEvent ServiceException: OccurrenceException

Supported API: true

Extendable: true
PathOccurrence This Occurrence identifies a unique path of UsesOccurrence objects, in order to deal with: the ambiguity inherent when any of the OccurrenceableLink objects have quantity greater than 1 the need to hang PathOccurrenceData off of the path of links .
PathOccurrenceContext This tagging interface allows classes of objects to provide the context for PathOccurrences (and CombinedPathOccurrences).
PathOccurrenceContextFilterDelegate This delegate filters a Vector of PathOccurrenceContext objects based on which contexts should have OccurrenceData associated with them.
PathOccurrenceData This tagging interface is associated with a PathOccurrence largely to allow external applications to easily add application-specifc information in a relatively transparent and extensible manner.
PathOccurrenceMasterContext This is the context for a PathOccurrence.
PathOccurrenceNewIterationDelegate  
PathOwner This interface is used to tag classes which participate in one of the roles of an OccurrenceableLink so that their associated PathOccurrence can have a null subPath.
PathParentableOccurrence This Occurrence can have a PathOccurrence as its parent and is used in defining a CombinedPathOccurrence.
UserIBAOccurrenceData This OccurrenceData is designed for user defined IBA values only and should not be used arbitrarily add attributes to an Occurrence which are not designed to be user settable.
UsesOccurrence This UsesOccurrence identifies a unique instance of an OccurrenceableLink in order to deal with: the ambiguity inherent when links have quantity greater than 1 the need to hang UsesOccurrenceData off of links the need to be a part of the path of UsesOccurrences that define a PathOccurrence
UsesOccurrenceContext This context for a UsesOccurrence is usually one of the roles of the associated OccurrenceableLink.
UsesOccurrenceCreationApprovalDelegate Determines if you can create another UsesOccurrence for a specific OccurrenceableLink object; it may say no in all cases for certain types of OccurrenceableLink objects.
UsesOccurrenceData This tagging interface is associated with a UsesOccurrence largely to allow external applications to easily add application-specifc information in a relatively transparent and extensible manner.
 

Class Summary
AllPathOccurrenceContextFilterDelegate This delegate implementation returns all of the PathOccurrenceContext objects.
CombinedPathMasterIteration Use the newCombinedPathMasterIteration static factory method(s), not the CombinedPathMasterIteration constructor, to construct instances of this class.
CombinedPathOccurrence This combines a parent PathOccurrence (owned by one PathOwner) with a child PathParentableOccurrence (owned by a different PathOwner); its context is the context of its parent.
CombinedPathOccurrenceDataLink Use the newCombinedPathOccurrenceDataLink static factory method(s), not the CombinedPathOccurrenceDataLink constructor, to construct instances of this class.
CombinedPathOccurrenceDataMaster Use the newCombinedPathOccurrenceDataMaster static factory method(s), not the CombinedPathOccurrenceDataMaster constructor, to construct instances of this class.
CombinedPathOccurrenceDocumentation This DocumentationOccurrenceData allows a CombinedPathOccurrence to have an associated WTDocument version.
CombinedPathOccurrenceModificationDelegate

Supported API: true

Extendable: true
CombinedPathOccurrenceUserIBAs This UserIBAOccurrenceData allows a CombinedPathOccurrence to have an associated wt.value.IBAHolder.
ContextCombinedPathOccurrenceData Use the newContextCombinedPathOccurrenceData static factory method(s), not the ContextCombinedPathOccurrenceData constructor, to construct instances of this class.
ContextPathOccurrence Use the newContextPathOccurrence static factory method(s), not the ContextPathOccurrence constructor, to construct instances of this class.
ContextPathOccurrenceData Use the newContextPathOccurrenceData static factory method(s), not the ContextPathOccurrenceData constructor, to construct instances of this class.
ContextTheCombinedPathOccurrence Use the newContextTheCombinedPathOccurrence static factory method(s), not the ContextTheCombinedPathOccurrence constructor, to construct instances of this class.
ContextTheUsesOccurrence Use the newContextTheUsesOccurrence static factory method(s), not the ContextTheUsesOccurrence constructor, to construct instances of this class.
CopyingOccurrenceDataCopyDelegate

Supported API: false

Extendable: false
DataOccurrenceForeignKey Use the newDataOccurrenceForeignKey static factory method(s), not the DataOccurrenceForeignKey constructor, to construct instances of this class.
DataOccurrenceReference This reference is to a set of UsesOccurrences that all share the same UsesOccurrenceData objects.
DefaultIteratedUsageLinkTerminationDelegate

Supported API: true

Extendable: true
IBAHelper This IBAHelper provides utility methods for managing IBA holders and IBA values within the OccurrenceService.
IBAHolderNewIterationDelegate  
LastPathOccurrenceContextFilterDelegate This delegate implementation returns the last PathOccurrenceContext object only.
LinkUsesOccurrence Use the newLinkUsesOccurrence static factory method(s), not the LinkUsesOccurrence constructor, to construct instances of this class.
NonCopyingOccurrenceDataCopyDelegate

Supported API: false

Extendable: false
OccurrenceCache  
OccurrenceCountCache  
OccurrenceDataIdentifierSeq

Supported API: false

Extendable: false
OccurrenceDelegateFactory

Supported API: true

Extendable: false
OccurrenceDocumentReference Use the newOccurrenceDocumentReference static factory method(s), not the OccurrenceDocumentReference constructor, to construct instances of this class.
OccurrenceEvent This event is emitted by the StandardOccurrenceService.
OccurrenceHelper This helper is used to access an implementation of OccurrenceService via the static reference OccurrenceHelper.service.
OccurrenceIdentifierSeq

Supported API: false

Extendable: false
OccurrenceServiceFwd This service interface defines the API for managing UsesOccurrences, PathOccurrences, CombinedPathOccurrences, UsesOccurrenceData, PathOccurrenceData and CombinedPathOccurrenceData in the context of OccurrenceableLinks, PathOccurrenceContexts and CombinedPathOccurrenceContexts Cookie: None Helper: OccurrenceHelper has helper methods Service implementation: StandardOccurrenceService has listeners ServiceEvent: OccurrenceEvent ServiceException: OccurrenceException

Supported API: false

Extendable: false
PathMasterIteration Use the newPathMasterIteration static factory method(s), not the PathMasterIteration constructor, to construct instances of this class.
PathOccurrenceDataLink Use the newPathOccurrenceDataLink static factory method(s), not the PathOccurrenceDataLink constructor, to construct instances of this class.
PathOccurrenceDataMaster Use the newPathOccurrenceDataMaster static factory method(s), not the PathOccurrenceDataMaster constructor, to construct instances of this class.
PathOccurrenceDocumentation This DocumentationOccurrenceData allows a PathOccurrence to have an associated WTDocument version.
PathOccurrenceModificationDelegate This OccurrenceModificationDelegate approves (or rejects) the modification of a PathOccurrence by ensuring that the user has MODIFY permission for each version of the associated context.
PathOccurrenceUserIBAs This UserIBAOccurrenceData allows a PathOccurrence to have an associated wt.value.IBAHolder.
SingleOccurrenceableLinkModificationDelegate This delegate approves all requests to modify an OccurrenceableLink; it should be used only for links whose modification never invalidates associated UsesOccurrence objects.
SingleUsesOccurrenceCreationApprovalDelegate This delegate rejects all requests to create a UsesOccurrence from an OccurrenceableLink with count > 1, but for count = 1 it checks to see if a link already exists and approves the creation if none exists.
StandardOccurrenceService This implementation of OccurrenceService implements the service API, send OccurrenceEvents and adds listeners in StandardOccurrenceService.performStartupProcess().
SubPathSuperPath Use the newSubPathSuperPath static factory method(s), not the SubPathSuperPath constructor, to construct instances of this class.
UniqueWithinPathOccurrenceContextOccurrenceNameValidationDelegate This delegate checks that a PathOccurrence name is unique among all that share the same PathOccurrenceContext.
UsesOccurrenceDataJoinDelegate Handles a join between a UsesOccurrence and a UsesOccurrenceData.
UsesOccurrenceDocumentation This DocumentationOccurrenceData allows a UsesOccurrence to have an associated WTDocument version.
UsesOccurrenceForeignKey This key is used to identify a UsesOccurrence.
UsesOccurrenceJoinDelegate Handles a join between a UsesOccurrence and a PathOccurrence.
UsesOccurrenceReference This reference uses a special UsesOccurrenceForeignKey to uniquely identify a UsesOccurrence for the purpose of associating it to PathOccurrences.
UsesOccurrenceUserIBAs This UserIBAOccurrenceData allows a UsesOccurrence to have an associated wt.value.IBAHolder.
 

Exception Summary
OccurrenceException The exception for the occurrence package.
 

Package wt.occurrence Description

Defines the capability to uniquely distinguish one occurrence of an object within some complex structure from another occurrence of that same object within the same structure using OccurrenceService.

Occurrences may be:

OccurrenceData may be:

See wt.part as the reference implementation of Occurrences:

Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
 PREV PACKAGE   NEXT PACKAGE FRAMES    NO FRAMES