BaseWorkFlowCheckerTask (parodos-model-api 1.0.6 API)

java.lang.Object
- com.redhat.parodos.workflow.task.BaseWorkFlowTask
- - com.redhat.parodos.workflow.task.checker.BaseWorkFlowCheckerTask

All Implemented Interfaces:

WorkFlowTask, Work, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware
```
public abstract class BaseWorkFlowCheckerTask
extends BaseWorkFlowTask
```
Basic Contract for checking if a manual process initiated by a @see WorkFlowTask has been completed

Author:

Luke Shannon (Github: lshannon), Richard Wang (Github: richardW98)

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`BaseWorkFlowCheckerTask()`
`protected`	`BaseWorkFlowCheckerTask(WorkFlow escalationWorkflow, long expectedSlaBeforeEscalationInSeconds)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract WorkReport`	`checkWorkFlowStatus(WorkContext context)`	Method to check if a WorkFlow that is in a holding status, i.e: waiting for an external process to occur, has achieved its status and can trigger the next WorkFlow
`WorkReport`	`execute(WorkContext workContext)`	By default, if no execute method is defined, the checkWorkFlowStatus method will be executed by the WorkFlow engine
`WorkFlowTaskType`	`getType()`

Methods inherited from class com.redhat.parodos.workflow.task.BaseWorkFlowTask
getOptionalParameterValue, getRequiredParameterValue, getWorkFlowCheckers, setBeanName, setWorkFlowCheckers

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.redhat.parodos.workflows.work.Work
getName

Methods inherited from interface com.redhat.parodos.workflow.task.WorkFlowTask
getAsJsonSchema, getWorkFlowTaskOutputs, getWorkFlowTaskParameters

- Constructor Detail
  - BaseWorkFlowCheckerTask
```
protected BaseWorkFlowCheckerTask(WorkFlow escalationWorkflow,
                                  long expectedSlaBeforeEscalationInSeconds)
```
  - BaseWorkFlowCheckerTask
```
protected BaseWorkFlowCheckerTask()
```
- Method Detail
  - checkWorkFlowStatus
```
protected abstract WorkReport checkWorkFlowStatus(WorkContext context)
```
    Method to check if a WorkFlow that is in a holding status, i.e: waiting for an external process to occur, has achieved its status and can trigger the next WorkFlow
    
    Parameters:
    
    context -
    
    Returns:
  - execute
```
public WorkReport execute(WorkContext workContext)
```
    By default, if no execute method is defined, the checkWorkFlowStatus method will be executed by the WorkFlow engine
  - getType
```
public WorkFlowTaskType getType()
```