public interface IStructuredReferenceHandler
StructuredReference for specific Domain Element,
and to resolve StructuredReference with a specific providerId to the domain Element.
Register the implementor of this interface with the com.ibm.xtools.mmi.core.StrcuturedReferenceProviders extension point,
to enable StructuredReferenceService to consult this as and when required.
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
getInfo(java.lang.Object referencedContext,
StructuredReference sRef,
java.lang.String infoName)
Returns the information requested for the specified StructuredReference.
|
StructuredReference |
getStructuredReference(java.lang.Object referencedContext,
java.lang.Object domainElement)
Gets the StructuredReference for the specified domain element.
|
StructuredReference |
getStructuredReference(java.lang.Object referencedContext,
java.lang.String sRefString)
Gets the StructuredReference for the specified serialized form of the StructuredReference.
|
java.lang.Object |
resolveToDomainElement(java.lang.Object referencedContext,
StructuredReference sRef)
Resolves the specified
StructuredReference to appropriate domain element |
void |
setStructuredReferenceModifier(IStructuredReferenceModifier modifier)
Called by
StructuredReferenceService to set the IStructuredReferenceModifier for this handler. |
java.lang.Object resolveToDomainElement(java.lang.Object referencedContext,
StructuredReference sRef)
StructuredReference to appropriate domain elementreferencedContext - Context in which this reference is used, usually an instance of TransactionalEditingDomainsRef - StructuredReference for which the domain element is requested.null if the domain element isn't resolvablejava.lang.Object getInfo(java.lang.Object referencedContext,
StructuredReference sRef,
java.lang.String infoName)
referencedContext - Context in which this reference is used, usually an instance of TransactionalEditingDomainsRef - StructuredReference for which the information is required.infoName - Identifier for the information requested, usually constants defined in StructuredReferenceInfoConstantsStructuredReferenceInfoConstantsStructuredReference getStructuredReference(java.lang.Object referencedContext, java.lang.String sRefString)
referencedContext - Context in which this reference will be used, usually an instance of TransactionalEditingDomainsRefString - serialized form of the StructuredReferencesRefStringStructuredReference getStructuredReference(java.lang.Object referencedContext, java.lang.Object domainElement)
referencedContext - Context in which this reference will be used, usually an instance of TransactionalEditingDomaindomainElement - Domain Element for which the StructuredReference is requesteddomainElementvoid setStructuredReferenceModifier(IStructuredReferenceModifier modifier)
StructuredReferenceService to set the IStructuredReferenceModifier for this handler.modifier - to be set in this handler.