Interface IDestination

Namespace

Dynamicweb.DataIntegration.Integration.Interfaces

Assembly

Dynamicweb.DataIntegration.dll

Add this interface if you are inheriting from a provider that is a destination

public interface IDestination

Extension Methods

ProviderExtensions.GetTableOptions(IDestination)

ProviderExtensions.IsDestinationFileProvider(IDestination)

ProviderExtensions.IsTableOptionsFeatureSupported(IDestination)

Properties

FilesFolderName

The Name of the files folder in the current installation of Dynamicweb. Empty if used for test.

string FilesFolderName { get; set; }

Property Value

string

Logger

Logger

ILogger? Logger { get; set; }

Property Value

ILogger

SchemaIsEditable

Gets or sets a value indicating whether the schema is editable.

bool SchemaIsEditable { get; }

Property Value

bool

true if schema is editable; otherwise, false.

WorkingDirectory

Gets or sets the working directory. When used for testing, all paths for standard providers are relative to this path.

string WorkingDirectory { get; set; }

Property Value

string

The working directory.

Methods

CheckMapping(Mapping)

List<SchemaComparerResult> CheckMapping(Mapping map)

Parameters

map Mapping

Returns

List<SchemaComparerResult>

Close(bool)

Closes this instance.

void Close(bool jobFailed)

Parameters

jobFailed bool

Job result.

GetDetails(string)

string? GetDetails(string id)

Parameters

id string

Returns

string

GetId()

string? GetId()

Returns

string

GetOriginalDestinationSchema()

Get recent Destination Tables Schema from the Destination source.

Schema GetOriginalDestinationSchema()

Returns

Schema

GetSchema()

Get Destination Tables Schema.

Schema GetSchema()

Returns

Schema

Initialize()

Initializes this instance.

void Initialize()

OverwriteDestinationSchemaToOriginal()

Update current tables schema with most recent schema. Needed for updation of possible old schema loaded from the xml job settings.

void OverwriteDestinationSchemaToOriginal()

RunJob(Job)

Runs the job. This is where the majority of the work is done.

bool RunJob(Job job)

Parameters

job Job

The job to be run.

Returns

bool

SaveAsXml(XmlTextWriter)

Saves as XML.

void SaveAsXml(XmlTextWriter textWriter)

Parameters

textWriter XmlTextWriter

The XMLTextWriter.

Serialize()

Serializes this instance for use in AddinSelectors. Output must be of the format yyy, where xxx is the name of AddinParamter, as defined in the decoration, and yyy is the value assigned to the paramter

string Serialize()

Returns

string

Serialized XML output describing addin paramters

UpdateDestinationSettings(IDestination)

Updates the destination settings of the current instance to match the settings of the "destination" paramter.

void UpdateDestinationSettings(IDestination destination)

Parameters

destination IDestination

The destination.

ValidateDestinationSettings()

Validates the destination settings. Used to validate properties when created by the AddinSelector.

string ValidateDestinationSettings()

Returns

string