com.appiancorp.suiteapi.process.events

Class MessageEventTrigger

java.lang.Object

com.appiancorp.suiteapi.process.events.Event

com.appiancorp.suiteapi.process.events.EventTrigger

com.appiancorp.suiteapi.process.events.MessageEventTrigger

All Implemented Interfaces:

JSONable, JSONCacheable, java.io.Serializable

public class MessageEventTrigger
extends EventTrigger

Represents a receive message event. This type of event waits for a message to come in directed to the process model, the process, or the event, and then evaluates the rules in the context of the message (i.e., you can use message properties in the rules with the syntax "msg!properties.XXX"; see InternalMessage).

See Also:

Serialized Form

Field Summary

Fields inherited from class com.appiancorp.suiteapi.process.events.Event

ERROR_EVENT_TRIGGER, MESSAGE_EVENT_PRODUCER, MESSAGE_EVENT_TRIGGER, RULE_EVENT_TRIGGER, SORT_BY_DESC, SORT_BY_ID, SORT_BY_NAME, TERMINATE_EVENT_PRODUCER, TIMER_EVENT_TRIGGER

Fields inherited from interface com.appiancorp.suiteapi.common.JSONable

hiddenAttributes$TRANSIENT

Constructor Summary

Constructors

Constructor and Description
MessageEventTrigger() Constructs a new MessageEventTrigger.

Method Summary

Modifier and Type	Method and Description
boolean	getActiveForLifeOfProcess() Gets whether the trigger, once activated, should remain active for the life of the process, even if it is fired.
java.lang.String	getMessageType() Gets the message type (this corresponds with the JMSType message property for incoming messages; see InternalMessage#getMessageType()).
void	setActiveForLifeOfProcess(boolean activeForLifeOfProcess_) Sets whether the trigger, once activated, should remain active for the life of the process, even if it is fired.
void	setMessageType(java.lang.String messageType_) Sets the message type (this corresponds with the JMSType message property for incoming messages; see InternalMessage#getMessageType()).

Methods inherited from class com.appiancorp.suiteapi.process.events.EventTrigger

createEventTrigger, getOutputs, getRules, setOutputs, setRules

Methods inherited from class com.appiancorp.suiteapi.process.events.Event

getDesc, getHiddenAttributes, getId, getName, getPersistentId, getType, isProducerType, isTriggerType, setDesc, setId, setName, setPersistentId, setType, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageEventTrigger

public MessageEventTrigger()

Constructs a new MessageEventTrigger. If you do not know the specific event producer type, use EventProducer.createEventProducer(Long).

Method Detail

getActiveForLifeOfProcess

public boolean getActiveForLifeOfProcess()

Gets whether the trigger, once activated, should remain active for the life of the process, even if it is fired.

Returns:

whether it should remain active for the life of the process

See Also:

setActiveForLifeOfProcess(boolean)

setActiveForLifeOfProcess

public void setActiveForLifeOfProcess(boolean activeForLifeOfProcess_)

Sets whether the trigger, once activated, should remain active for the life of the process, even if it is fired.

Parameters:

activeForLifeOfProcess_ - whether it should remain active for the life of the process

See Also:

getActiveForLifeOfProcess()

getMessageType

public java.lang.String getMessageType()

Gets the message type (this corresponds with the JMSType message property for incoming messages; see InternalMessage#getMessageType()). Message types are registered in /process/conf/message-types.xml.

Returns:

the message type

See Also:

setMessageType(String)

setMessageType

public void setMessageType(java.lang.String messageType_)

Sets the message type (this corresponds with the JMSType message property for incoming messages; see InternalMessage#getMessageType()).

Parameters:

messageType_ - the message type

See Also:

getMessageType()