|
JSCAPE MFT Server | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Action
Represents an abstraction for executing custom tasks if an event occurs. Action is executed only once after creation. The interface introduces methods and properties required by action invocation infrastructure.
Nested Class Summary | |
---|---|
static class |
Action.ActionException
Represents an action execution error. |
Method Summary | |
---|---|
void |
execute(com.jscape.util.event.EventContext context,
java.lang.String triggerName)
Executes action for specified event context and trigger name. |
java.lang.String |
getDescription()
Returns action description used in Manager GUI. |
java.lang.String |
getPropertyDescription(java.lang.String propertyName)
Returns action property description. |
PropertyDescriptor[] |
getPropertyDescriptors()
Returns action properties descriptors used for creating action properties panel in Manager GUI. |
java.lang.String |
getPropertyExample(java.lang.String propertyName)
Returns action property usage example. |
java.lang.String |
getResultMessage()
Returns result message for logging. |
java.lang.String |
getTriggerErrorMessage()
Returns an error message passed to Trigger Error Event. |
java.lang.String |
getTriggerName()
Returns parent trigger name. |
boolean |
isLogAction()
Returns action loggable flag. |
boolean |
isSuccess()
Returns action success flag. |
void |
setEventContext(java.util.Map<java.lang.String,java.lang.Object> value)
Sets action event context as a map of event property name to property value. |
void |
setLogAction(boolean value)
Sets action loggable flag. |
Method Detail |
---|
java.lang.String getDescription()
java.lang.String getPropertyDescription(java.lang.String propertyName)
propertyName
- the property name
java.lang.String getPropertyExample(java.lang.String propertyName)
propertyName
- the property name
PropertyDescriptor[] getPropertyDescriptors()
boolean isLogAction()
true
if action should be logged;
false
otherwisevoid setLogAction(boolean value)
value
- if true
action will be loggedjava.lang.String getTriggerName()
java.lang.String getTriggerErrorMessage()
java.lang.String getResultMessage()
boolean isSuccess()
true
if action was successful executed;
false
otherwisevoid setEventContext(java.util.Map<java.lang.String,java.lang.Object> value)
value
- event contextvoid execute(com.jscape.util.event.EventContext context, java.lang.String triggerName) throws Action.ActionException
context
- an event contexttriggerName
- a trigger name
Action.ActionException
- if an execution error occurs
|
JSCAPE MFT Server | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |