org.jbpm.pvm
Class SignalDefinition

java.lang.Object
  org.jbpm.pvm.SignalDefinition

All Implemented Interfaces:

java.io.Serializable

public class SignalDefinition
extends java.lang.Object
implements java.io.Serializable

describes the signature of an external trigger.

Author:

Tom Baeyens

See Also:

Serialized Form

Nested Class Summary

static class

SignalDefinition.SetBuilder

Field Summary

static SignalDefinition	DEFAULT
protected java.lang.String	description
protected java.lang.String	name
protected java.util.Map<java.lang.String,java.lang.Class<?>>	parameterDefinitions
protected java.util.Map<java.lang.String,java.lang.Object>	properties

Constructor Summary

SignalDefinition()

SignalDefinition(java.lang.String name)

Method Summary

static SignalDefinition.SetBuilder	build()
java.lang.String	getDescription() a free text description
java.lang.String	getName() the signal name that corresponds to the value of the signal parameter in the Execution.signal(String) method.
java.util.Map<java.lang.String,java.lang.Class<?>>	getParameterDefinitions() specifies the type of java object of the parameters that must be fed into this signal.
static java.util.Set<java.lang.String>	getSignalNames(java.util.List<SignalDefinition> signalDefinitions)
void	setDescription(java.lang.String description) a free text description
void	setName(java.lang.String name) the signal name that corresponds to the value of the signal parameter in the Execution.signal(String) method.
void	setParameterDefinitions(java.util.Map<java.lang.String,java.lang.Class<?>> parameterDefinitions) specifies the type of java object of the parameters that must be fed into this signal.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final SignalDefinition DEFAULT

name

protected java.lang.String name

description

protected java.lang.String description

parameterDefinitions

protected java.util.Map<java.lang.String,java.lang.Class<?>> parameterDefinitions

properties

protected java.util.Map<java.lang.String,java.lang.Object> properties

Constructor Detail

SignalDefinition

public SignalDefinition()

SignalDefinition

public SignalDefinition(java.lang.String name)

Method Detail

build

public static SignalDefinition.SetBuilder build()

getSignalNames

public static java.util.Set<java.lang.String> getSignalNames(java.util.List<SignalDefinition> signalDefinitions)

getName

public java.lang.String getName()

the signal name that corresponds to the value of the signal parameter in the Execution.signal(String) method.

setName

public void setName(java.lang.String name)

the signal name that corresponds to the value of the signal parameter in the Execution.signal(String) method.

getDescription

public java.lang.String getDescription()

a free text description

setDescription

public void setDescription(java.lang.String description)

a free text description

getParameterDefinitions

public java.util.Map<java.lang.String,java.lang.Class<?>> getParameterDefinitions()

specifies the type of java object of the parameters that must be fed into this signal.

setParameterDefinitions

public void setParameterDefinitions(java.util.Map<java.lang.String,java.lang.Class<?>> parameterDefinitions)

specifies the type of java object of the parameters that must be fed into this signal. Overwrites the full map. Null is allowed.