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
,Serializable
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:
-
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
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Gets whether the trigger, once activated, should remain active for the life of the process, even if it is fired.Gets the message type (this corresponds with the JMSType message property for incoming messages; seeInternalMessage#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
(String messageType_) Sets the message type (this corresponds with the JMSType message property for incoming messages; seeInternalMessage#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
-
Constructor Details
-
MessageEventTrigger
public MessageEventTrigger()Constructs a new MessageEventTrigger. If you do not know the specific event producer type, useEventProducer.createEventProducer(Long)
.
-
-
Method Details
-
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
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:
-
getMessageType
Gets the message type (this corresponds with the JMSType message property for incoming messages; seeInternalMessage#getMessageType()
). Message types are registered in /process/conf/message-types.xml.- Returns:
- the message type
- See Also:
-
setMessageType
Sets the message type (this corresponds with the JMSType message property for incoming messages; seeInternalMessage#getMessageType()
).- Parameters:
messageType_
- the message type- See Also:
-