Package com.redhat.parodos.workflow.option

Class WorkFlowOption

java.lang.Object
com.redhat.parodos.workflow.option.WorkFlowOption
public class WorkFlowOption extends Object
An WorkFlowOption is an identifier for a collection of @see WorkFlowTasks that can be presented to a user as an option to choose from.

WorkFlowOption contains both the information to be displayed to the User to determine if they want to select the WorkFlow, and also the information to execute the WorkFlow

workFlowId: unique identifier for this Workflow option. An example could be platformname + workflowName (ie: AwsOcpAnsibleSelfHealingV1). This should correspond to the value the workflow-service end points expect to execute a Workflow

name: a readable/user-friendly label for the WorkflowOption

description: a high level description related to the WorkflowOption

details: a collection of strings that can provide optional details (i.e: internal charge back for the tooling to be stood up)

As much of this information is already required for the @see WorkFlowDefinition, this object is leveraged to reduce having to specify the same information in two different places

Author:
Luke Shannon (Github: lshannon)