Assembly: OptimaJet.Workflow.Core

Interface IApprovalProvider

OptimaJet.Workflow.Core.Persistence.IApprovalProvider

Defines persistence operations for the approval inbox, approval history, and approval outbox used by ApprovalPlugin.

Namespace: OptimaJet.Workflow.Core.Persistence

public interface IApprovalProvider

Type Hierarchy

Methods

Task DropWorkflowInboxAsync(Guid processId) #
Removes all approval inbox entries associated with the specified process instance.

Parameters

Name
Type
Description
processId
Guid
The identifier of the process instance whose inbox entries are removed.

Returns

Type
Description
Task
A task that represents the asynchronous operation.
Task InsertInboxAsync(List<InboxItem> inboxItems) #
Adds approval inbox entries.

Parameters

Name
Type
Description
inboxItems
List<InboxItem>
The InboxItem objects to add.

Returns

Type
Description
Task
A task that represents the asynchronous operation.
Task<int> GetInboxCountByProcessIdAsync(Guid processId) #
Gets the number of approval inbox entries associated with the specified process instance.

Parameters

Name
Type
Description
processId
Guid
The identifier of the process instance whose inbox entries are counted.

Returns

Type
Description
Task<Int32>
A task whose result is the number of matching inbox entries.
Task<int> GetInboxCountByIdentityIdAsync(string identityId) #
Gets the number of approval inbox entries available to the specified workflow participant identity.

Parameters

Name
Type
Description
identityId
String
The workflow participant identity whose inbox entries are counted.

Returns

Type
Description
Task<Int32>
A task whose result is the number of matching inbox entries.
Task<List<InboxItem>> GetInboxByProcessIdAsync(Guid processId, Paging paging = null, CultureInfo culture = null) #
Gets approval inbox entries associated with the specified process instance.

Parameters

Name
Type
Description
processId
Guid
The identifier of the process instance whose inbox entries are retrieved.
paging
Paging
The optional Paging settings that select a page of results.
culture
CultureInfo
The CultureInfo used to localize the command names in InboxItem.AvailableCommands, or null to use CultureInfo.CurrentCulture.

Returns

Type
Description
Task<InboxItem>
A task whose result contains the matching InboxItem objects.
Task<List<InboxItem>> GetInboxByIdentityIdAsync(string identityId, Paging paging = null, CultureInfo culture = null) #
Gets approval inbox entries available to the specified workflow participant identity.

Parameters

Name
Type
Description
identityId
String
The workflow participant identity whose inbox entries are retrieved.
paging
Paging
The optional Paging settings that select a page of results.
culture
CultureInfo
The CultureInfo used to localize the command names in InboxItem.AvailableCommands, or null to use CultureInfo.CurrentCulture.

Returns

Type
Description
Task<InboxItem>
A task whose result contains the matching InboxItem objects.
Task FillApprovalHistoryAsync(ApprovalHistoryItem approvalHistoryItem) #
Adds approvalHistoryItem to approval history or updates a matching pending entry.

Parameters

Name
Type
Description
approvalHistoryItem
ApprovalHistoryItem
The ApprovalHistoryItem containing the approval history data to add or apply.

Returns

Type
Description
Task
A task that represents the asynchronous operation.
Task DropEmptyApprovalHistoryAsync(Guid processId) #
Removes approval history entries that have no ApprovalHistoryItem.TransitionTime and are associated with the specified process instance.

Parameters

Name
Type
Description
processId
Guid
The identifier of the process instance whose pending entries are removed.

Returns

Type
Description
Task
A task that represents the asynchronous operation.
Task DropApprovalHistoryByProcessIdAsync(Guid processId) #
Removes all approval history entries associated with the specified process instance.

Parameters

Name
Type
Description
processId
Guid
The identifier of the process instance whose approval history is removed.

Returns

Type
Description
Task
A task that represents the asynchronous operation.
Task DropApprovalHistoryByIdentityIdAsync(string identityId) #
Removes approval history entries recorded for the specified executor.

Parameters

Name
Type
Description
identityId
String
The workflow participant identity of the executor whose approval history entries are removed.

Returns

Type
Description
Task
A task that represents the asynchronous operation.
Task<int> GetApprovalHistoryCountByProcessIdAsync(Guid processId) #
Gets the number of approval history entries associated with the specified process instance.

Parameters

Name
Type
Description
processId
Guid
The identifier of the process instance whose approval history entries are counted.

Returns

Type
Description
Task<Int32>
A task whose result is the number of matching approval history entries.
Task<int> GetApprovalHistoryCountByIdentityIdAsync(string identityId) #
Gets the number of approval history entries recorded for the specified executor.

Parameters

Name
Type
Description
identityId
String
The workflow participant identity of the executor whose approval history entries are counted.

Returns

Type
Description
Task<Int32>
A task whose result is the number of matching approval history entries.
Task<List<ApprovalHistoryItem>> GetApprovalHistoryByProcessIdAsync(Guid processId, Paging paging = null) #
Gets approval history entries associated with the specified process instance.

Parameters

Name
Type
Description
processId
Guid
The identifier of the process instance whose approval history is retrieved.
paging
Paging
The optional Paging settings that select a page of results.

Returns

Type
Description
Task<ApprovalHistoryItem>
A task whose result contains the matching ApprovalHistoryItem objects.
Task<List<ApprovalHistoryItem>> GetApprovalHistoryByIdentityIdAsync(string identityId, Paging paging = null) #
Gets approval history entries recorded for the specified executor.

Parameters

Name
Type
Description
identityId
String
The workflow participant identity of the executor whose approval history is retrieved.
paging
Paging
The optional Paging settings that select a page of results.

Returns

Type
Description
Task<ApprovalHistoryItem>
A task whose result contains the matching ApprovalHistoryItem objects.
Task<int> GetOutboxCountByIdentityIdAsync(string identityId) #
Gets the number of process-specific OutboxItem summaries for the specified executor.

Parameters

Name
Type
Description
identityId
String
The workflow participant identity of the executor whose approval history is summarized.

Returns

Type
Description
Task<Int32>
A task whose result is the number of process-specific approval summaries.
Task<List<OutboxItem>> GetOutboxByIdentityIdAsync(string identityId, Paging paging = null) #
Gets process-specific OutboxItem summaries of approvals performed by the specified executor.

Parameters

Name
Type
Description
identityId
String
The workflow participant identity of the executor whose approval history is summarized.
paging
Paging
The optional Paging settings that select a page of results.

Returns

Type
Description
Task<OutboxItem>
A task whose result contains the matching OutboxItem objects.