Interface SzEnvironment

Namespace

Senzing.Sdk

Assembly

Senzing.Sdk.dll

Provides a factory interface for obtaining the references to the Senzing SDK singleton instances that have been initialized.

public interface SzEnvironment

Methods

Destroy()

Destroys this SzEnvironment and invalidates any SDK singleton references that has previously provided.

void Destroy()

Remarks

If this instance has already been destroyed then this method has no effect.

GetActiveConfigID()

Gets the currently active configuration ID for this SzEnvironment.

long GetActiveConfigID()

Returns

long

The currently active configuration ID.

Exceptions

InvalidOperationException

If this SzEnvironment instance has been destroyed.

SzException

If there was a failure in obtaining the active config ID.

GetConfig()

Provides a reference to the SzConfig instance associated with this SzEnvironment.

SzConfig GetConfig()

Returns

SzConfig

The SzConfig instance associated with this SzEnvironment.

Exceptions

InvalidOperationException

If this SzEnvironment instance has been destroyed.

SzException

If there was a failure in obtaining or initializing the SzConfig instance.

GetConfigManager()

Provides a reference to the SzConfigManager instance associated with this SzEnvironment.

SzConfigManager GetConfigManager()

Returns

SzConfigManager

The SzConfigManager instance associated with this SzEnvironment.

Exceptions

InvalidOperationException

If this SzEnvironment instance has been destroyed.

SzException

If there was a failure in obtaining or initializing the SzConfigManager instance.

GetDiagnostic()

Provides a reference to the SzDiagnostic instance associated with this SzEnvironment.

SzDiagnostic GetDiagnostic()

Returns

SzDiagnostic

The SzDiagnostic instance associated with this SzEnvironment.

Exceptions

InvalidOperationException

If this SzEnvironment instance has been destroyed.

SzException

If there was a failure in obtaining or initializing the SzDiagnostic instance.

GetEngine()

Provides a reference to the SzEngine instance associated with this SzEnvironment.

SzEngine GetEngine()

Returns

SzEngine

The SzEngine instance associated with this SzEnvironment.

Exceptions

InvalidOperationException

If this SzEnvironment instance has been destroyed.

SzException

If there was a failure in obtaining or initializing the SzEngine instance.

GetProduct()

Provides a reference to the SzProduct singleton associated with this SzEnvironment.

SzProduct GetProduct()

Returns

SzProduct

The SzProduct instance associated with this SzEnvironment

Exceptions

InvalidOperationException

If this SzEnvironment instance has been destroyed.

SzException

If there was a failure in obtaining or initializing the SzProduct instance.

IsDestroyed()

Checks if this instance has had its Destroy() method called.

bool IsDestroyed()

Returns

bool

true if this instance has had its Destroy()
method called, otherwise false.

Reinitialize(long)

Reinitializes the SzEnvironment with the specified configuration ID.

void Reinitialize(long configID)

Parameters

configID long

The configuraiton ID with which to initialize.

Exceptions

InvalidOperationException

If this SzEnvironment instance has been destroyed.

SzException

If there was a failure reinitializing.