Class Step

java.lang.Object

org.tasktide.core.model.collection.Step

All Implemented Interfaces:

TaskTideModel<Step>

@Entity
public class Step
extends Object
implements TaskTideModel<Step>

Model class for a collection of work items as metadata

Constructor Summary

Constructors

Constructor	Description
Step()	Null value constructor
Step(String stepId, String stepName)	Constructor for JSON deserialization
Step(String stepId, String stepName, String workflowId, CustomAnnotation anno)	Constructor for JSON deserialization

Method Summary

Modifier and Type	Method	Description
CustomAnnotation	getAnnotations()	Get annotations
String	getCollection()	Return workflow id
String	getId()	TaskTideModel interface method to return Id
String	getState()	Return current of model
String	getStepId()	Get step Id
String	getStepName()	Get step name
Object	getValueFromField(String field)	TaskTideModel interface get the value from the required field
Workflow	getWorkflow()	Get parent workflow Id
String	getWorkflowId()	Get parent workflow Id
void	resetModel()	Reset model
void	setAnnotations(CustomAnnotation anno)	Set provided CustomAnnotation
void	setStepId(String stepId)	Set step Id
void	setStepName(String stepName)	Set step name
void	setWorkflowId(String workflowId)	Set parent workflow Id
void	setWorkflowId(Workflow workflow)	Set workflow
String	toJson()	TaskTideModel interface method to represent as JsonDoc
String	toJsonDoc()	Serialize to a human readable formatted JSON string
String	toJsonString()	Serialize to JSON string
String	toString()	Represent as string

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Step

public Step()

Null value constructor

Step

public Step(String stepId,
 String stepName)

Constructor for JSON deserialization

Parameters:

stepId -

stepName -

Step

public Step(String stepId,
 String stepName,
 String workflowId,
 CustomAnnotation anno)

Constructor for JSON deserialization

Parameters:

stepId -

stepName -

workflowId -

anno -

Method Details

getAnnotations

public CustomAnnotation getAnnotations()

Get annotations

Specified by:

getAnnotations in interface TaskTideModel<Step>

Returns:

CustomAnnotation

setAnnotations

public void setAnnotations(CustomAnnotation anno)

Set provided CustomAnnotation

Specified by:

setAnnotations in interface TaskTideModel<Step>

Parameters:

anno -

resetModel

public void resetModel()

Reset model

Specified by:

resetModel in interface TaskTideModel<Step>

getStepId

public String getStepId()

Get step Id

Returns:

String

setStepId

public void setStepId(String stepId)

Set step Id

Parameters:

stepId -

getWorkflowId

public String getWorkflowId()

Get parent workflow Id

Returns:

String

setWorkflowId

public void setWorkflowId(String workflowId)

Set parent workflow Id

Parameters:

workflowId -

getWorkflow

public Workflow getWorkflow()

Get parent workflow Id

Returns:

String

setWorkflowId

public void setWorkflowId(Workflow workflow)

Set workflow

Parameters:

workflow -

getCollection

public String getCollection()

Return workflow id

Specified by:

getCollection in interface TaskTideModel<Step>

Returns:

getStepName

public String getStepName()

Get step name

Returns:

String

setStepName

public void setStepName(String stepName)

Set step name

Parameters:

stepName -

getState

public String getState()

Description copied from interface: TaskTideModel

Return current of model

Specified by:

getState in interface TaskTideModel<Step>

Returns:

String

toString

public String toString()

Represent as string

Overrides:

toString in class Object

Returns:

String

toJsonString

public String toJsonString()

Serialize to JSON string

Returns:

String

toJsonDoc

public String toJsonDoc()

Serialize to a human readable formatted JSON string

Specified by:

toJsonDoc in interface TaskTideModel<Step>

Returns:

String

toJson

public String toJson()

TaskTideModel interface method to represent as JsonDoc

Specified by:

toJson in interface TaskTideModel<Step>

Returns:

String

getId

public String getId()

TaskTideModel interface method to return Id

Specified by:

getId in interface TaskTideModel<Step>

Returns:

String

getValueFromField

public Object getValueFromField(String field)

TaskTideModel interface get the value from the required field

Specified by:

getValueFromField in interface TaskTideModel<Step>

Parameters:

field -

Returns:

Object