51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile Interface Reference

Detailed Description

Interface for the details of a data file used by an Aspect engine.

These properties are used by the DataUpdateService to perform automatic updates if enabled.

Inheritance diagram for FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile:

[legend]

Public Member Functions

void  SetDataUpdateService (IDataUpdateService dataUpdateService)
Set the data update service that this data file is registered with. More...

Properties

string  Identifier [get, set]
An identifier for this data file. More...
IOnPremiseAspectEngine  Engine [get, set]
The engine this data file is used by More...
Type  EngineType [get]
Get the type of the engine that this data file is for. More...
string  DataFilePath [get]
The complete file path to the location of the data file. More...
string  TempDataDirPath [get, set]
The path to use when working with temporary files associated with this data file. More...
string  TempDataFilePath [get, set]
The complete file path to the location of the temporary copy of the data file that is currently being used by the IAspectEngine. More...
bool  AutomaticUpdatesEnabled [get]
True if automatic updates are enabled, false otherwise. More...
DateTime  UpdateAvailableTime [get, set]
The date and time by which an update to the current data file is expected to have been published. More...
DateTime  DataPublishedDateTime [get, set]
The date and time that the current data file was published. More...
IDataFileConfiguration  Configuration [get, set]
The configuration that was provided for this data file. More...
string  FormattedUrl [get]
Get the data update URL complete with any query string parameters that are needed to retrieve the data. More...
Uri  FormattedUri [get]
Get the data update URL complete with any query string parameters that are needed to retrieve the data. More...
bool  IsRegistered [get]
Returns true if this file has been registered with the data update service. More...

Member Function Documentation

Property Documentation

◆ AutomaticUpdatesEnabled

bool FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.AutomaticUpdatesEnabled
get

True if automatic updates are enabled, false otherwise.

◆ Configuration

IDataFileConfiguration FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.Configuration
get set

The configuration that was provided for this data file.

◆ DataFilePath

string FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.DataFilePath
get

The complete file path to the location of the data file.

This value will be null if the file has been supplied from a byte[] in memory.

◆ DataPublishedDateTime

DateTime FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.DataPublishedDateTime
get set

The date and time that the current data file was published.

◆ Engine

IOnPremiseAspectEngine FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.Engine
get set

The engine this data file is used by

◆ EngineType

Type FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.EngineType
get

Get the type of the engine that this data file is for.

This exists in addition to the Engine property because Engine can be null. This then allows the user to identify which engine this file relates to.

◆ FormattedUri

Uri FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.FormattedUri
get

Get the data update URL complete with any query string parameters that are needed to retrieve the data.

By default, no query string parameters are added to the URL.

◆ FormattedUrl

string FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.FormattedUrl
get

Get the data update URL complete with any query string parameters that are needed to retrieve the data.

By default, no query string parameters are added to the URL.

◆ Identifier

string FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.Identifier
get set

An identifier for this data file.

Each data file used by an engine must have a different identifier.

◆ IsRegistered

bool FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.IsRegistered
get

Returns true if this file has been registered with the data update service.

False if not.

◆ TempDataDirPath

string FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.TempDataDirPath
get set

The path to use when working with temporary files associated with this data file.

◆ TempDataFilePath

string FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.TempDataFilePath
get set

The complete file path to the location of the temporary copy of the data file that is currently being used by the IAspectEngine.

Engines often make a temporary copy of the data file in order to allow the original to be updated. This value will be null if the file is loaded entirely into memory.

◆ UpdateAvailableTime

DateTime FiftyOne.Pipeline.Engines.Data.IAspectEngineDataFile.UpdateAvailableTime
get set

The date and time by which an update to the current data file is expected to have been published.