Click or drag to resize

ExternalReferenceResolver Class

This class implements the IExternalReferenceResolverAsync service interface. With this service it is possible to access CAEX objects which are outsourced into external documents and referenced using alias names. Normally the service is located by other services like query services. They can call this service to resolve an external reference if an alias is part of a CAEX path in any query.
Inheritance Hierarchy
SystemObject
  Aml.Engine.ServicesExternalReferenceResolver

Namespace: Aml.Engine.Services
Assembly: Aml.Engine.Services (in Aml.Engine.Services.dll) Version: 3.2
Syntax
public class ExternalReferenceResolver : IExternalReferenceResolverAsync, 
	IExternalReferenceResolver, IAMLService, IXMLDocumentRegistry, IXMLExternalUnload

The ExternalReferenceResolver type exposes the following members.

Methods
 NameDescription
Public methodClearRedirection Clears all registered redirection paths.
Public methodClearRedirection(String) Clears the redirection path for the provided address.
Public methodIsExternal Determines, if the provided XElement is part of an external document.
Public methodLoadOrGetReferencedDocument(ExternalReferenceType) This method is used to load an outsourced CAEX document. The external representation for that document is defined in the provided ExternalReference object. The CAEXDocument is loaded as a new 'stand alone' document, which means that no libraries of the loaded document are merged to the original referencing document. The ExternalReference is not changed and all external references in the original document which use the alias name in a path- or id-reference will not change too. A merge of documents can only be requested by a IMerge service.
Public methodLoadOrGetReferencedDocument(CAEXDocument, String) Determines, if the provided path contains an alias and gets the resolved document for that alias.
Public methodLoadOrGetReferencedDocumentAsync(ExternalReferenceType) Async version of LoadOrGetReferencedDocument(ExternalReferenceType)
Public methodLoadOrGetReferencedDocumentAsync(CAEXDocument, String) Async method of LoadOrGetReferencedDocument(CAEXDocument, String)
Public methodStatic memberRegister Registers a service to resolve external references.
Public methodRegisterExternalDocument Registers a CAEXDocument, referenced by the specified externalReference as an external document.
Public methodRemoveDocument Removes the document from the internal registry of the service.
Public methodResolvedDocuments Gets all already resolved externals for the provided CAEXDocument containing ExternalReference objects
Public methodResolveExternalDocument Resolves a CAEXDocument, referenced by the specified url.
Public methodResolveExternalDocumentAsync Async version of ResolveExternalDocument(String)
Public methodSetRedirection Sets a redirection path for the provided address.
Public methodUnloadExternalDocument Unloads the external document which was referenced by the provided externalReference.
Public methodStatic memberUnRegister Unregister this service
Top
See Also