com.createtank.elemenope.bpm
Interface ElemenopeBpmPayload


public interface ElemenopeBpmPayload

Interface for payloads which will contain attributes affecting the JMS/Asynchronous properties for the BPM. To use, one's payload object should implement this interface, and subsequently store the desired message attributes (e.g. priority) in the payload itself. The JMS/Async BPM framework will check for implementation of this interface. If the payload object has implemented, the BPM framework will set the corresponding values on the message.

Author:
John Joseph Roets [joe@createtank.com]

Field Summary
static java.lang.String BPM_KEY_CORRELATION
           
static java.lang.String BPM_KEY_CORRELATION_AS_OBJECT
           
static java.lang.String BPM_KEY_EXPIRATION
           
static java.lang.String BPM_KEY_PRIORITY
           
 
Method Summary
 java.util.Map getBpmAttributes()
           
 java.lang.String getBpmCorrelationId()
           
 java.lang.Object getBpmCorrelationIdAsObject()
           
 long getBpmExpiration()
           
 int getBpmPriority()
           
 boolean isBpmHalted()
           
 void requestBpmHalt()
           
 

Field Detail

BPM_KEY_PRIORITY

static final java.lang.String BPM_KEY_PRIORITY
See Also:
Constant Field Values

BPM_KEY_CORRELATION

static final java.lang.String BPM_KEY_CORRELATION
See Also:
Constant Field Values

BPM_KEY_CORRELATION_AS_OBJECT

static final java.lang.String BPM_KEY_CORRELATION_AS_OBJECT
See Also:
Constant Field Values

BPM_KEY_EXPIRATION

static final java.lang.String BPM_KEY_EXPIRATION
See Also:
Constant Field Values
Method Detail

getBpmPriority

int getBpmPriority()

getBpmCorrelationId

java.lang.String getBpmCorrelationId()

getBpmCorrelationIdAsObject

java.lang.Object getBpmCorrelationIdAsObject()

getBpmExpiration

long getBpmExpiration()

getBpmAttributes

java.util.Map getBpmAttributes()

requestBpmHalt

void requestBpmHalt()

isBpmHalted

boolean isBpmHalted()