WJb Docs - Reference

CompleteResult

Represents successful workflow completion.

CompleteResult indicates that the current action has finished and no additional workflow commands should be generated.

Purpose

Use CompleteResult when a workflow has reached its final step.

Job
 ↓
Action
 ↓
CompleteResult
 ↓
Workflow Complete

Typical Usage

A terminal action commonly returns a completion result.

return Results.Complete();

In most applications, Results.Complete() is preferred over creating a CompleteResult instance directly.

Execution Flow

Action
 ↓
CompleteResult
 ↓
JobCommand
 ↓
Job Succeeded

The executor interprets the result and finalizes the workflow.

When to Use

Use CompleteResult when:

• Processing has finished
• No additional jobs are required
• A workflow reaches its final stage
• Business work has been completed successfully

Send Email
Generate Invoice
Archive File
Publish Notification

when no follow-up work is needed.

When Not to Use

Do not use CompleteResult when execution should continue.

For follow-up work, use a result that creates workflow transitions.

Validate
 ↓
Import
 ↓
Notify

Intermediate workflow steps are typically not terminal operations.

Relationship to Results

Results provides a factory method for creating completion results.

Results.Complete()
          ↓
    CompleteResult

Relationship to NextResult

CompleteResult ends a workflow.

NextResult continues a workflow.

CompleteResult
      ↓
    Finish

NextResult
     ↓
 Continue

Best Practices

• Prefer Results.Complete().
• Use completion only for terminal workflow states.
• Keep workflow transitions explicit.

Related Types

• Results
• IActionResult
• NextResult
• JobCommand

See Also

• Results
• IActionResult
• NextResult