IConnector Interface

Implementations of this will be pluggable into our universal data access engine. This is a linked file that needs to be .NET 4 compatible.

Namespace:  Scribe.Core.ConnectorApi

Assembly:  Scribe.Core.ConnectorApi (in Scribe.Core.ConnectorApi.dll)

Syntax

The IConnector type exposes the following members.

Methods

	Name	Description
	Connect	This method will attempt to connect to the third-party.
	Disconnect	This method will attempt to disconnect from the third-party.
	ExecuteMethod	This method will execute a Method returning a result.
	ExecuteOperation	This method will execute an operation returning a result. This method is also used in bulk operations.
	ExecuteQuery	The Connector will perform the query and pass the results back in an enumerable set of DataEntities. Each of which could be a set of objects
	GetMetadataProvider	Gets the metadata provider.
	PreConnect	This method will attempt to connect to the third-party and retrieve properties such as organizations databases etc. If the generic ConnectionUI is to be used, this method must return the serialized FormDefinition that will define connection properties.

Properties

	Name	Description
	ConnectorTypeId	Gets ConnectorTypeId.
	IsConnected	Gets a value indicating whether the Connector is connected to its third-party.

See

Scribe.Core.ConnectorApi Namespace