Inetdev Framework

ParameterProvider

Default parameter provider.

Namespace:
Inetdev.Parameters
Type:
Class
Public:
Yes
Protected:
No
Sealed:
Yes
Abstract:
No
Inherits from:
System.Object
Implements:
Inetdev.Parameters.IParameterProvider

Constructors

ParameterProvider

Default constructor

Signature:
public Void ParameterProvider()

Properties

ParameterStore

The name of the parameter store object.

Signature:
public IParameterStore ParameterStore { get; set; }

ParameterTree

Parameters configuration for this provider.

Signature:
public IParameterTreeNode ParameterTree { get; }

Methods

Exists

Checks whether parameterName exists.

Signature:
public Boolean Exists(parameterName)
Returns

true if the parameter exists, otherwise false.

Parameters
Name Type Summary
parameterName String The name of the parameter to check.
Exceptions
Type Summary
ArgumentNullOrEmptyException Thrown when parameterName is null or empty.

GetAsync

Get a parameter.

Signature:
public Task<IParameter> GetAsync(parameterName)
Returns

The IParameter for the requested parameter.

Parameters
Name Type Summary
parameterName String The name of the parameter to retrive.
Exceptions
Type Summary
ArgumentNullOrEmptyException Thrown when parameterName is null or empty.
MissingRequiredPropertyException Thrown when the ParameterStore property is not set.
ParameterDoesNotExistException Thrown when the requested parameter does not exist.
ParameterConfigurationException Thrown when there is configuration error.
ParameterException Thrown when there is an error getting the parameter.

In this document