Class WorkflowEvent

java.lang.Object

org.opentestfactory.messages.OTFMessage

org.opentestfactory.messages.WorkflowEvent

Direct Known Subclasses:

AbstractExecutionEvent, ExecutionError, GeneratorCommand, ProviderCommand

public abstract class WorkflowEvent
extends OTFMessage

This class defines all common parts for messages that are part of a workflow.

Author:

edegenetais

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	JOB_ORIGIN_KEY

Fields inherited from class OTFMessage

apiVersion, NAME_KEY, WORKFLOW_ID_KEY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WorkflowEvent(String apiVersion)

Method Summary

Modifier and Type	Method	Description
String	jobId()	Shortcut to get mandatory metadata job_id.
List<String>	jobOrigin()	Shortcut to get mandatory metadata job_origin.
String	name()	Shortcut to get mandatory metadata name.
String	workflowId()	Shortcut to get mandatory metadata workflow_id.

Methods inherited from class OTFMessage

addMetadata, checkKind, equals, getApiVersion, getKind, getMetadata, hashCode, setApiVersion, setMetadata

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

JOB_ORIGIN_KEY

protected static final String JOB_ORIGIN_KEY

See Also:

• Constant Field Values

Constructor Details

WorkflowEvent

protected WorkflowEvent(String apiVersion)

Method Details

workflowId

public String workflowId()

Shortcut to get mandatory metadata workflow_id.

Returns:

the workflow_id

name

public String name()

Shortcut to get mandatory metadata name.

Returns:

the workflow_id

jobId

public String jobId()

Shortcut to get mandatory metadata job_id.

jobOrigin

public List<String> jobOrigin()

Shortcut to get mandatory metadata job_origin.