Class AssignmentApi

Inheritance

↳ object

    ↳ AssignmentApi

Inherited Members

Equals(object)

Equals(object, object)

GetHashCode()

GetType()

ReferenceEquals(object, object)

ToString()

Namespace: OptimaJet.Workflow.Core.Runtime

Assembly: OptimaJet.Workflow.Core.dll

Syntax

public sealed class AssignmentApi

Constructors

AssignmentApi(WorkflowRuntime)

Declaration

public AssignmentApi(WorkflowRuntime runtimeOwner)

Parameters

Type	Name	Description
WorkflowRuntime	runtimeOwner

Methods

GetAssignmentsAsync(AssignmentFilter, Paging, List<(string parameterName, SortDirection sortDirection)>)

Get a list of assignments by AssignmentFilter with sorting and paging

Declaration

public Task<List<Assignment>> GetAssignmentsAsync(AssignmentFilter filter, Paging paging = null, List<(string parameterName, SortDirection sortDirection)> orderParameters = null)

Parameters

Type	Name	Description
AssignmentFilter	filter	<xref href="OptimaJet.Workflow.Core.Model.AssignmentFilter" data-throw-if-not-resolved="false"></xref>
Paging	paging	<xref href="OptimaJet.Workflow.Core.Persistence.Paging" data-throw-if-not-resolved="false"></xref>
List<(string parameterName, SortDirection sortDirection)>	orderParameters	List of order parameters

Returns

Type	Description
Task<List<Assignment>>	List of <xref href="OptimaJet.Workflow.Core.Model.Assignment" data-throw-if-not-resolved="false"></xref>

GetAssignmentStatuses()

Get a list of assignment statuses

Declaration

public List<string> GetAssignmentStatuses()

Returns

Type	Description
List<string>	List of assignment statuses

UpdateAssignmentAsync(Assignment)

Updating assignment with process resuming

Declaration

public Task<bool> UpdateAssignmentAsync(Assignment assignment)

Parameters

Type	Name	Description
Assignment	assignment	<xref href="OptimaJet.Workflow.Core.Model.Assignment" data-throw-if-not-resolved="false"></xref> for updating

Returns

Type	Description
Task<bool>	Was resumed

CreateAssignmentAsync(Guid, AssignmentCreationForm)

Creating assignment from AssignmentCreationForm with process resuming

Declaration

public Task<bool> CreateAssignmentAsync(Guid processId, AssignmentCreationForm assignmentCreationForm)

Parameters

Type	Name	Description
Guid	processId	Process id
AssignmentCreationForm	assignmentCreationForm	<xref href="OptimaJet.Workflow.Core.Model.AssignmentCreationForm" data-throw-if-not-resolved="false"></xref>

Returns

Type	Description
Task<bool>	Was resumed

DeleteAssignmentAsync(Guid)

Deleting without saving in the database by assignmentId with process resuming

Declaration

public Task<bool> DeleteAssignmentAsync(Guid assignmentId)

Parameters

Type	Name	Description
Guid	assignmentId	Assignment id

Returns

Type	Description
Task<bool>	Was resumed

DeleteAssignmentAsync(Guid, Guid)

Deleting without saving in the database with process resuming

Declaration

public Task<bool> DeleteAssignmentAsync(Guid processId, Guid assignmentId)

Parameters

Type	Name	Description
Guid	processId	Process id
Guid	assignmentId	Assignment id

Returns

Type	Description
Task<bool>	Was resumed

Fields

OnUpdateAssignment

Declaration

public OnUpdateAssignmentDelegate OnUpdateAssignment

Returns

Type	Description
OnUpdateAssignmentDelegate

OnPostUpdateAssignment

Declaration

public OnUpdateAssignmentDelegate OnPostUpdateAssignment

Returns

Type	Description
OnUpdateAssignmentDelegate

Extension Methods

• Extensions.CastAs<T>(object)
• Extensions.ExtendedEquals(object, object)
• Extensions.TryCast<T>(object, out T)