Class DataProviderVariable

Namespace

BiExcellence.OpenBi.Api.DataProviders

Assembly

BiExcellence.OpenBi.Api.Client.dll

A question the source asks before it delivers data.

public sealed class DataProviderVariable : DataProviderElement

Inheritance

object

DataProviderElement

DataProviderVariable

Inherited Members

DataProviderElement.Id

DataProviderElement.Name

Constructors

DataProviderVariable()

Creates an empty variable.

public DataProviderVariable()

DataProviderVariable(DataProviderVariable)

Creates a copy, filters and default filters included.

public DataProviderVariable(DataProviderVariable variable)

Parameters

variable DataProviderVariable

DataProviderVariable(string)

Creates a variable with this id.

public DataProviderVariable(string id)

Parameters

id string

Properties

DataType

The data type of the answer, where the source states one.

[JsonPropertyName("dataType")]
[JsonConverter(typeof(NullableDbTypeJsonConverter))]
public DbType? DataType { get; set; }

Property Value

DbType?

DefaultFilters

The answers the variable is defined with - what it uses until something is set on it. More than one is a variable that answers with any of them. Set these to define a variable's own values; set Filters to answer it afterwards.

[JsonPropertyName("defaultFilters")]
public List<DataProviderFilter> DefaultFilters { get; set; }

Property Value

List<DataProviderFilter>

DimensionId

The dimension the answer is a value of.

[JsonPropertyName("dimensionId")]
public string? DimensionId { get; set; }

Property Value

string

EntryType

Whether the variable has to be answered.

[JsonPropertyName("entryType")]
public DataProviderVariableEntryType EntryType { get; set; }

Property Value

DataProviderVariableEntryType

Filterable

Whether value help is available for it.

[JsonPropertyName("filterable")]
public bool Filterable { get; set; }

Property Value

bool

Filters

The answer set on the variable, which takes the place of its defined values.

[JsonPropertyName("filters")]
public List<DataProviderFilter> Filters { get; set; }

Property Value

List<DataProviderFilter>

HierarchyName

The hierarchy the answer is a node of, for a hierarchy variable.

[JsonPropertyName("hierarchyName")]
public string? HierarchyName { get; set; }

Property Value

string

HierarchyValidTo

The key date that hierarchy is read at.

[JsonPropertyName("hierarchyValidTo")]
public string? HierarchyValidTo { get; set; }

Property Value

string

HierarchyVersion

The version of that hierarchy.

[JsonPropertyName("hierarchyVersion")]
public string? HierarchyVersion { get; set; }

Property Value

string

InputReady

Whether the caller may answer it at all, or the source fixes the value.

[JsonPropertyName("inputReady")]
public bool InputReady { get; set; }

Property Value

bool

Selection

How many values the variable accepts. A single value unless stated otherwise.

[JsonPropertyName("selection")]
public DataProviderVariableSelection Selection { get; set; }

Property Value

DataProviderVariableSelection

Type

What the variable asks for. A characteristic value unless stated otherwise.

[JsonPropertyName("type")]
public DataProviderVariableType Type { get; set; }

Property Value

DataProviderVariableType