Kpok Patagon Framework

IParameterService

Defines a service to get and set parameter values.

Namespace:
KpokPatagon.Multitenancy.Commons.Parameters
Type:
Interface
Public:
Yes
Protected:
No
Sealed:
No
Abstract:
Yes

Methods

GetBoolean

Gets a parameter value as boolean.

Signature:
public Boolean GetBoolean(name, tenant)
Returns

The value of the parámeter as boolean.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
tenant TTenant The tenant to which the parameter belongs to.

GetBooleanAsync

Gets a parameter value as boolean.

Signature:
public Task GetBooleanAsync(name, tenant)
Returns

The value of the parámeter as boolean.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
tenant TTenant The tenant to which the parameter belongs to.

GetInteger

Gets a parameter value as an integer.

Signature:
public Int32 GetInteger(name, tenant)
Returns

The value of the parámeter as integer.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
tenant TTenant The tenant to which the parameter belongs to.

GetIntegerAsync

Gets a parameter value as an integer.

Signature:
public Task GetIntegerAsync(name, tenant)
Returns

The value of the parámeter as integer.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
tenant TTenant The tenant to which the parameter belongs to.

GetString

Gets a parameter value as a string.

Signature:
public String GetString(name, tenant)
Returns

The value of the parámeter as string.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
tenant TTenant The tenant to which the parameter belongs to.

GetStringAsync

Gets a parameter value as a string.

Signature:
public Task GetStringAsync(name, tenant)
Returns

The value of the parámeter as string.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
tenant TTenant The tenant to which the parameter belongs to.

LoadParametersTree

Returns a parameter tree as a DTO including the parameter values from the store is required.

Signature:
public ParameterTreeNodeDto LoadParametersTree(tenant, includeStoredValues)
Parameters
Name Type Summary
tenant TTenant The tenant to which the parameter belongs to.
includeStoredValues Boolean Whether the values from the store must be included.

LoadParametersTree

Returns a parameter tree as a DTO including the parameter values from the store is required.

Signature:
public ParameterTreeNodeDto LoadParametersTree(groupName, tenant, includeStoredValues)
Parameters
Name Type Summary
groupName String Name of the group from where to start loading parameters.
tenant TTenant The tenant to which the parameter belongs to.
includeStoredValues Boolean Whether the values from the store must be included.

LoadParametersTreeAsync

Returns a parameter tree as a DTO including the parameter values from the store is required.

Signature:
public Task LoadParametersTreeAsync(tenant, includeStoredValues)
Parameters
Name Type Summary
tenant TTenant The tenant to which the parameter belongs to.
includeStoredValues Boolean Whether the values from the store must be included.

LoadParametersTreeAsync

Returns a parameter tree as a DTO including the parameter values from the store is required.

Signature:
public Task LoadParametersTreeAsync(groupName, tenant, includeStoredValues)
Parameters
Name Type Summary
groupName String Name of the group from where to start loading parameters.
tenant TTenant The tenant to which the parameter belongs to.
includeStoredValues Boolean Whether the values from the store must be included.

SetValue

Sets the value of the parameter.

Signature:
public Void SetValue(name, value, tenant)
Parameters
Name Type Summary
name String The name of the parameter to set it's value.
value String The value to be set.
tenant TTenant The tenant to which the parameter belongs to.

SetValueAsync

Sets the value of the parameter.

Signature:
public Task SetValueAsync(name, value, tenant)
Parameters
Name Type Summary
name String The name of the parameter to set it's value.
value String The value to be set.
tenant TTenant The tenant to which the parameter belongs to.

In this document