Package wt.identity

Provides the interfaces and implementations necessary to produce localized identification information for Windchill objects.

See:
Description

Interface Summary

DisplayIdentification	Provides displayable identification information about an object.
DisplayIdentificationDelegate	A DisplayIdentificationDelegate object can produce all the necessary information to produce a DisplayIdentification object for another object.
DisplayIdentity	Provides access to the essential displayable charactistics about the identity of an object.
IteratedDisplayIdentity	Supported API: true Extendable: true
TypeMessageCalculatorInterface	Used for old client only.
VersionedDisplayIdentity	Defines the identity of versioned information.
ViewManageableDisplayIdentity	Supported API: true Extendable: true

Class Summary

DisplayIdentificationIteratedDelegate	Supported API: true Extendable: true
DisplayIdentificationObjectDelegate	Provides Identification information for a java.lang.Object object.
DisplayIdentificationPersistableDelegate	Provides Identification information for a Persistable object.
DisplayIdentificationRevisionControlledDelegate	Provides Identification information for a Revision Controlled object.
DisplayIdentificationStandardDelegate	This is a standard delegate implementation for providing display identification information for objects.
DisplayIdentificationStandardVersionedDelegate	Handles DisplayIdentification for versioned objects that are wt.vc.Iterated.
DisplayIdentificationVersionedDelegate	This is a standard delegate implementation for providing display identification information for versioned objects.
DisplayIdentificationWTDocumentDelegate	Deprecated. As of R2.1, replaced by DisplayIdentificationRevisionControlledDelegate
DisplayIdentificationWTDocumentMasterDelegate	Provides Identification information for a WTDocumentMaster object.
DisplayIdentificationWTPartDelegate	Provides Identification information for a WTPart object.
DisplayIdentificationWTPartMasterDelegate	Provides Identification information for a WTPartMaster object.
IdentityFactory	Factory object that can issue DisplayInformation about other objects.
NonTypedDelegate	Used for old client only.
SecuredIdentificationDelegate	Supported API: true Extendable: false
StandardDisplayIdentity	Implements DisplayIdentity using a resource bundle and message key.
StandardIterationDisplayIdentity	Supported API: true Extendable: false
StandardNumberedNamedIdentifier	Provides a basic means to extract and format a number field and name field from an object.
StandardRevisionDisplayIdentity	Uses resource bundle wt.identity.identityResource and tags identityResource.REVISION_IDENTITY and identityResource.REVISION_BRIEF to format the identity for a revision.
StandardRevisionViewDisplayIdentity	Uses resource bundle wt.identity.identityResource and tags identityResource.REVISION_VIEW_IDENTITY to format the identity, identityResource.REVISION_VIEW_TYPOE to provide the text label for a revision and view value label and identityResource.REVISION_VIEW_NULL to format a null value.
StandardVersionedDisplayIdentity	Implements DisplayIdentity for versioned objects Supported API: true Extendable: false
StandardViewDisplayIdentity	Uses resource bundle wt.identity.identityResource and tags identityResource.VIEW_IDENTITY to format the identity, identityResource.VIEW to provide the text label for "view" and identityResource.VIEW_NULL to format a null view value.
StandardViewVersionedDisplayIdentity	Supported API: true Extendable: false

Package wt.identity Description

Provides the interfaces and implementations necessary to produce localized identification information for Windchill objects. The identification encapsulated by this package consists of a type (such as "Document") and identifier (such as a name and number combination) which can be combined to produce the identity (a DisplayIdentity which can either be localized as is or decomposed into type/identifier components) of the object. This package provides the standard mechanism for providing clients locale-specific display information about Windchill objects.

Most customizers will need only be aware of the getDisplayType, getDisplayIdentifier, and getDisplayIdentity APIs available on either the object itself (assuming it implements DisplayIdentification) or via the IdentityFactory. For Versioned data, the DisplayIdentity returned is, in fact, a VersionedDisplayIdentity, which provides additional components, allowing the concept's (master) and version's identities to be treated distinctly.

Customizers wishing to add identity capabilities to their customized objects need to be aware of the following:

• DisplayIdentificationDelegate and its implementations (namely DisplayIdentificationStandardDelegate), which is responsible for producing the DisplayIdentity objects on behalf of a particular object.
• service.properties and the use of xconf entries to drive delegation (via the wt.identity.DisplayIdentification delegate.
• wt.util.LocalizableMessage implementations to produce type/identifier messages.
• The use of resource bundles to provide localized display information.

Note that DisplayIdentificationDelegate implementations typically implement the initializeXXXX methods (rather than the initialize method itself). They should be fault-tolerant, providing DisplayIdentification in all circumstances (regardless of the state of the object); they should not throw exceptions. Information that the user does not have access to should not be visible in the objects returned by these APIs; consider building a standard "secured info" (identitityResource.SECURED_INFO) localizable message.