Class OpenBiTransportTaskExtensions

Extension methods for transport task and transport task elements.

Inheritance

object

OpenBiTransportTaskExtensions

Namespace: BiExcellence.OpenBi.Api.Commands.Configurator

Assembly: BiExcellence.OpenBi.Api.Configurator.dll

Syntax

public static class OpenBiTransportTaskExtensions

Methods

AssignElementToTransportTaskAsync(IOpenBiSession, ITransportTaskElement, ITransportTask, CancellationToken)

Assigns a transport task element to a transport task.

Declaration

public static Task AssignElementToTransportTaskAsync(this IOpenBiSession session, ITransportTaskElement transportTaskElement, ITransportTask transportTask, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
ITransportTaskElement	transportTaskElement	The transport task element.
ITransportTask	transportTask	The transport task.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

AssignElementToTransportTaskAsync(IOpenBiSession, ITransportTaskElement, string, CancellationToken)

Assigns a transport task element to a transport task id.

Declaration

public static Task AssignElementToTransportTaskAsync(this IOpenBiSession session, ITransportTaskElement transportTaskElement, string transportTaskId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
ITransportTaskElement	transportTaskElement	The transport task element.
string	transportTaskId	The transport task id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

CreateTransportTaskAsync(IOpenBiSession, ITransportTask, CancellationToken)

Creates or updates a transport task.

Declaration

public static Task CreateTransportTaskAsync(this IOpenBiSession session, ITransportTask transportTask, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
ITransportTask	transportTask	The transport task.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteTransportTaskAsync(IOpenBiSession, ITransportTask, CancellationToken)

Deletes a transport task.

Declaration

public static Task DeleteTransportTaskAsync(this IOpenBiSession session, ITransportTask transportTask, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
ITransportTask	transportTask	The transport task.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

DeleteTransportTaskAsync(IOpenBiSession, string, CancellationToken)

Deletes a transport task by its id.

Declaration

public static Task DeleteTransportTaskAsync(this IOpenBiSession session, string id, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	id	The transport task id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

GetTransportTaskElementsAsync(IOpenBiSession, ITransportTask, CancellationToken)

Returns transport task elements for a transport task.

Declaration

public static Task<IList<ITransportTaskElement>> GetTransportTaskElementsAsync(this IOpenBiSession session, ITransportTask transportTask, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
ITransportTask	transportTask	The transport task.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<ITransportTaskElement>>

GetTransportTaskElementsAsync(IOpenBiSession, string, CancellationToken)

Returns transport task elements for a transport task id.

Declaration

public static Task<IList<ITransportTaskElement>> GetTransportTaskElementsAsync(this IOpenBiSession session, string transportTaskId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
string	transportTaskId	The transport task id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task<IList<ITransportTaskElement>>

GetTransportTasksAsync(IOpenBiSession, CancellationToken)

Returns all transport tasks.

Declaration

public static Task<IList<ITransportTask>> GetTransportTasksAsync(this IOpenBiSession session, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<IList<ITransportTask>>

GetTransportTasksByStateAsync(IOpenBiSession, string, CancellationToken)

Returns all transport tasks for a state.

Declaration

public static Task<IList<ITransportTask>> GetTransportTasksByStateAsync(this IOpenBiSession session, string state, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<IList<ITransportTask>>

RemoveElementFromTransportTaskAsync(IOpenBiSession, ITransportTaskElement, CancellationToken)

Removes a transport task element from a transport task.

Declaration

public static Task RemoveElementFromTransportTaskAsync(this IOpenBiSession session, ITransportTaskElement transportTaskElement, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
ITransportTaskElement	transportTaskElement	The transport task element.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task

RemoveElementFromTransportTaskAsync(IOpenBiSession, int, CancellationToken)

Removes a transport task element from a transport task.

Declaration

public static Task RemoveElementFromTransportTaskAsync(this IOpenBiSession session, int transportTaskElementId, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
IOpenBiSession	session	The session.
int	transportTaskElementId	The transport task element id.
CancellationToken	cancellationToken	The cancellation token.

Returns

Type	Description
Task