Package io.serverlessworkflow.api.states

Class SwitchState

java.lang.Object

io.serverlessworkflow.api.states.DefaultState

io.serverlessworkflow.api.states.SwitchState

All Implemented Interfaces:

State, Serializable

@Generated("jsonschema2pojo")
public class SwitchState
extends DefaultState
implements Serializable, State

Permits transitions to other states based on criteria matching

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class io.serverlessworkflow.api.states.DefaultState

DefaultState.Type

Constructor Summary

Constructors

Constructor	Description
SwitchState()	No args constructor for use in serialization
SwitchState(DefaultConditionDefinition defaultCondition, String name, DefaultState.Type type)

Method Summary

Modifier and Type	Method	Description
List<DataCondition>	getDataConditions()	Defines conditions evaluated against state data
DefaultConditionDefinition	getDefaultCondition()	Switch state default condition definition (Required)
List<EventCondition>	getEventConditions()	Defines conditions evaluated against events
boolean	isUsedForCompensation()	If true, this state is used to compensate another state.
void	setDataConditions(List<DataCondition> dataConditions)	Defines conditions evaluated against state data
void	setDefaultCondition(DefaultConditionDefinition defaultCondition)	Switch state default condition definition (Required)
void	setEventConditions(List<EventCondition> eventConditions)	Defines conditions evaluated against events
void	setUsedForCompensation(boolean usedForCompensation)	If true, this state is used to compensate another state.
SwitchState	withCompensatedBy(String compensatedBy)
SwitchState	withDataConditions(List<DataCondition> dataConditions)
SwitchState	withDefaultCondition(DefaultConditionDefinition defaultCondition)
SwitchState	withEnd(End end)
SwitchState	withEventConditions(List<EventCondition> eventConditions)
SwitchState	withId(String id)
SwitchState	withMetadata(Map<String,String> metadata)
SwitchState	withName(String name)
SwitchState	withOnErrors(List<Error> onErrors)
SwitchState	withStateDataFilter(StateDataFilter stateDataFilter)
SwitchState	withTimeouts(TimeoutsDefinition timeouts)
SwitchState	withTransition(Transition transition)
SwitchState	withType(DefaultState.Type type)
SwitchState	withUsedForCompensation(boolean usedForCompensation)

Methods inherited from class io.serverlessworkflow.api.states.DefaultState

getCompensatedBy, getEnd, getId, getMetadata, getName, getOnErrors, getStateDataFilter, getTimeouts, getTransition, getType, setCompensatedBy, setEnd, setId, setMetadata, setName, setOnErrors, setStateDataFilter, setTimeouts, setTransition, setType

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.serverlessworkflow.api.interfaces.State

getCompensatedBy, getEnd, getId, getMetadata, getName, getOnErrors, getStateDataFilter, getTimeouts, getTransition, getType

Constructor Detail

SwitchState

public SwitchState()

No args constructor for use in serialization

SwitchState

public SwitchState(DefaultConditionDefinition defaultCondition,
                   String name,
                   DefaultState.Type type)

Parameters:

defaultCondition - Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition.

name - Unique name of the state.

type - State type.

Method Detail

getEventConditions

public List<EventCondition> getEventConditions()

Defines conditions evaluated against events

setEventConditions

public void setEventConditions(List<EventCondition> eventConditions)

Defines conditions evaluated against events

withEventConditions

public SwitchState withEventConditions(List<EventCondition> eventConditions)

getDataConditions

public List<DataCondition> getDataConditions()

Defines conditions evaluated against state data

setDataConditions

public void setDataConditions(List<DataCondition> dataConditions)

Defines conditions evaluated against state data

withDataConditions

public SwitchState withDataConditions(List<DataCondition> dataConditions)

getDefaultCondition

public DefaultConditionDefinition getDefaultCondition()

Switch state default condition definition (Required)

setDefaultCondition

public void setDefaultCondition(DefaultConditionDefinition defaultCondition)

Switch state default condition definition (Required)

withDefaultCondition

public SwitchState withDefaultCondition(DefaultConditionDefinition defaultCondition)

isUsedForCompensation

public boolean isUsedForCompensation()

If true, this state is used to compensate another state. Default is false

setUsedForCompensation

public void setUsedForCompensation(boolean usedForCompensation)

If true, this state is used to compensate another state. Default is false

withUsedForCompensation

public SwitchState withUsedForCompensation(boolean usedForCompensation)

withId

public SwitchState withId(String id)

Overrides:

withId in class DefaultState

withName

public SwitchState withName(String name)

Overrides:

withName in class DefaultState

withType

public SwitchState withType(DefaultState.Type type)

Overrides:

withType in class DefaultState

withEnd

public SwitchState withEnd(End end)

Overrides:

withEnd in class DefaultState

withStateDataFilter

public SwitchState withStateDataFilter(StateDataFilter stateDataFilter)

Overrides:

withStateDataFilter in class DefaultState

withMetadata

public SwitchState withMetadata(Map<String,String> metadata)

Overrides:

withMetadata in class DefaultState

withTransition

public SwitchState withTransition(Transition transition)

Overrides:

withTransition in class DefaultState

withOnErrors

public SwitchState withOnErrors(List<Error> onErrors)

Overrides:

withOnErrors in class DefaultState

withCompensatedBy

public SwitchState withCompensatedBy(String compensatedBy)

Overrides:

withCompensatedBy in class DefaultState

withTimeouts

public SwitchState withTimeouts(TimeoutsDefinition timeouts)

Overrides:

withTimeouts in class DefaultState