Class DataProviderView

Represents a data proivder view.

Inheritance

object

DataProviderView

Implements

• IDataProviderView
• IAsyncDisposable

Namespace: BiExcellence.OpenBi.Api.Commands.DataProviders

Assembly: BiExcellence.OpenBi.Api.DataProvider.dll

Syntax

public class DataProviderView : IDataProviderView, IAsyncDisposable

Constructors

DataProviderView(IOpenBiSession, IDataProvider?, string, IDataProviderDefinition)

Initializes a new instance of the DataProviderView class.

Declaration

public DataProviderView(IOpenBiSession session, IDataProvider? dataProvider, string dataProviderName, IDataProviderDefinition dataProviderDefinition)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IDataProvider	dataProvider	The data provider.
string	dataProviderName	The data provider name.
IDataProviderDefinition	dataProviderDefinition	The data provider definition.

DataProviderView(IOpenBiSession, string, IDataProviderDefinition)

Initializes a new instance of the DataProviderView class.

Declaration

public DataProviderView(IOpenBiSession session, string dataProviderName, IDataProviderDefinition dataProviderDefinition)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The data provider name.
IDataProviderDefinition	dataProviderDefinition	The data provider definition.

Properties

DataProviderDefinition

Gets or sets the data provider definition.

Declaration

public IDataProviderDefinition DataProviderDefinition { get; set; }

Property Value

Type	Description
IDataProviderDefinition

DataProviderName

Gets the data provider name.

Declaration

public string DataProviderName { get; }

Property Value

Type	Description
string

Session

Gets the session.

Declaration

public IOpenBiSession Session { get; }

Property Value

Type	Description
IOpenBiSession

Methods

DisposeAsync()

Deletes the data provider on the server.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask

ToString()

Returns the DataProviderName.

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Events

Executed

Event which is fired after an execute.

Declaration

public event EventHandler<GridDefinitionEventArgs>? Executed

Event Type

Type	Description
EventHandler<GridDefinitionEventArgs>

Executing

Event which is fired before an execute.

Declaration

public event EventHandler? Executing

Event Type

Type	Description
EventHandler

Implements

• IDataProviderView
• IAsyncDisposable

Extension Methods

• DataProviderViewExtensions.CreateDataCommentAsync(IDataProviderView, IKeyFigure, IEnumerable<KeyValuePair<IDimension, string>>, string, bool, CancellationToken)
• DataProviderViewExtensions.CreateDataCommentAsync(IDataProviderView, int, int, string, bool, CancellationToken)
• DataProviderViewExtensions.DeleteDataCommentAsync(IDataProviderView, string, CancellationToken)
• DataProviderViewExtensions.DeleteDimensionsAsync(IDataProviderView, IEnumerable<IDimension>, CancellationToken)
• DataProviderViewExtensions.DeleteKeyFiguresAsync(IDataProviderView, IEnumerable<IKeyFigure>, CancellationToken)
• DataProviderViewExtensions.DeleteVariablesAsync(IDataProviderView, IEnumerable<IVariable>, CancellationToken)
• DataProviderViewExtensions.ExecuteAsync(IDataProviderView, IEnumerable<IAffectedDataProvider>?, CancellationToken)
• DataProviderViewExtensions.ExecuteAsync(IDataProviderView, CancellationToken)
• DataProviderViewExtensions.GetChartDataAsync(IDataProviderView, bool?, bool?, bool?, bool?, bool?, CancellationToken)
• DataProviderViewExtensions.GetDataCommentsAsync(IDataProviderView, CancellationToken)
• DataProviderViewExtensions.GetDataProviderDefinitionAsync(IDataProviderView, CancellationToken)
• DataProviderViewExtensions.GetExportDocumentAsync(IDataProviderView, string, CancellationToken)
• DataProviderViewExtensions.GetF4ValuesAsync(IDataProviderView, IDimension, IEnumerable<IVariable>, CancellationToken)
• DataProviderViewExtensions.GetF4ValuesAsync(IDataProviderView, IDimension, CancellationToken)
• DataProviderViewExtensions.GetF4ValuesAsync(IDataProviderView, IVariable, IFilter, CancellationToken)
• DataProviderViewExtensions.GetF4ValuesAsync(IDataProviderView, IVariable, IEnumerable<IVariable>, IFilter, CancellationToken)
• DataProviderViewExtensions.GetF4ValuesAsync(IDataProviderView, IVariable, IEnumerable<IVariable>, CancellationToken)
• DataProviderViewExtensions.GetF4ValuesAsync(IDataProviderView, IVariable, CancellationToken)
• DataProviderViewExtensions.GetGridDataAsync(IDataProviderView, bool?, bool?, bool?, CancellationToken)
• DataProviderViewExtensions.GetGridDataSliceAsync(IDataProviderView, bool?, bool?, bool?, int?, int?, int?, int?, CancellationToken)
• DataProviderViewExtensions.GetGridDataSliceWithHeadersAsync(IDataProviderView, bool?, bool?, bool?, int?, int?, int?, int?, CancellationToken)
• DataProviderViewExtensions.SaveViewAsync(IDataProviderView, string?, CancellationToken)
• Utils.FireEvent<T>(object, string, T)
• Utils.FireEvent<T>(object, string, object, T)