Class OpenBiMasterDataExtensions

Extension methods for master data and master data hierarchies.

Inheritance

object

OpenBiMasterDataExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.MasterData

Assembly: BiExcellence.OpenBi.Api.MasterData.dll

Syntax

public static class OpenBiMasterDataExtensions

Methods

CreateHierarchyAsync(IOpenBiSession, string, IMasterDataHierarchy, CancellationToken)

Creates or updates a master data hierarchy.

Declaration

public static Task CreateHierarchyAsync(this IOpenBiSession session, string dataProviderName, IMasterDataHierarchy hierarchy, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The data provider name.
IMasterDataHierarchy	hierarchy	The master data hierarchy.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateMasterDataAsync(IOpenBiSession, string, IEnumerable<IMasterData>, IMasterDataAttributes, CancellationToken)

Creates or updates master data.

Declaration

public static Task CreateMasterDataAsync(this IOpenBiSession session, string dataProviderName, IEnumerable<IMasterData> masterData, IMasterDataAttributes masterDataAttributes, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The data provider name.
IEnumerable<IMasterData>	masterData	The master data.
IMasterDataAttributes	masterDataAttributes	The master data attributes.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateMasterDataAsync(IOpenBiSession, string, IEnumerable<IMasterData>, CancellationToken)

Creates or updates master data.

Declaration

public static Task CreateMasterDataAsync(this IOpenBiSession session, string dataProviderName, IEnumerable<IMasterData> masterData, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The data provider name.
IEnumerable<IMasterData>	masterData	The master data.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateMasterDataAttributeAsync(IOpenBiSession, IMasterDataAttribute, CancellationToken)

Creates or updates a master data attribute.

Declaration

public static Task CreateMasterDataAttributeAsync(this IOpenBiSession session, IMasterDataAttribute masterDataAttribute, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
IMasterDataAttribute	masterDataAttribute	The master data attribute.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateMasterDataObjectAsync(IOpenBiSession, string, CancellationToken)

Creates a new master data object.

Declaration

public static Task CreateMasterDataObjectAsync(this IOpenBiSession session, string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	name	The name.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteHierarchyAsync(IOpenBiSession, string, IMasterDataHierarchy, CancellationToken)

Deletes a master data hierarchy.

Declaration

public static Task DeleteHierarchyAsync(this IOpenBiSession session, string dataProviderName, IMasterDataHierarchy hierarchy, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The data provider name.
IMasterDataHierarchy	hierarchy	The master data hierarchy.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteHierarchyAsync(IOpenBiSession, string, string, CancellationToken)

Deletes a master data hierachy by id.

Declaration

public static Task DeleteHierarchyAsync(this IOpenBiSession session, string dataProviderName, string hierarchyId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The data provider name.
string	hierarchyId	The master data hierarchy id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

GetHierarchyAsync(IOpenBiSession, string, string, CancellationToken)

Returns a master data hierarchy by its id.

Declaration

public static Task<IMasterDataHierarchy> GetHierarchyAsync(this IOpenBiSession session, string dataProviderName, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The dataprovider name.
string	id	The master data hierarchy id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IMasterDataHierarchy>

GetMasterData(IOpenBiSession, string, IMasterDataAttributes)

Returns master data.

Declaration

public static IListRequest<IMasterData> GetMasterData(this IOpenBiSession session, string dataProviderName, IMasterDataAttributes masterDataAttributes)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataProviderName	The data provider name.
IMasterDataAttributes	masterDataAttributes	The master data attributes.

Returns

Type	Description
IListRequest<IMasterData>

GetMasterData(IOpenBiSession, string)

Returns master data.

Declaration

public static IListRequest<IMasterData> GetMasterData(this IOpenBiSession session, string dataProviderName)

Parameters

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

Returns

Type	Description
IListRequest<IMasterData>

GetMasterDataAttributesAsync(IOpenBiSession, string, CancellationToken)

Returns all master data attributes.

Declaration

public static Task<IMasterDataAttributes> GetMasterDataAttributesAsync(this IOpenBiSession session, string dataproviderName, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	dataproviderName	The data provider name.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IMasterDataAttributes>