|
JSCAPE MFT Server | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jscape.inet.mft.workflow.AbstractAction
public abstract class AbstractAction
Introduces a basic implementation of the Action
interface
and simplifies further actions development.
Nested Class Summary | |
---|---|
static class |
AbstractAction.LogActionField
|
Nested classes/interfaces inherited from interface com.jscape.inet.mft.workflow.Action |
---|
Action.ActionException |
Field Summary | |
---|---|
static PropertyDescriptor |
ACTION_PRIORITY_DESCRIPTOR
A property descriptor for 'Priority' property. |
static int |
DEFAULT_PRIORITY
Default action priority. |
static PropertyDescriptor |
LOG_ACTION_DESCRIPTOR
A property descriptor for 'LogAction' property. |
static PropertyDescriptor |
TRIGGER_ERROR_MESSAGE_DESCRIPTOR
A property descriptor for 'TriggerErrorMessage' property. |
Method Summary | |
---|---|
void |
execute(com.jscape.util.event.EventContext context,
java.lang.String triggerName)
Executes action for specified event context and trigger name. |
int |
getPriority()
Returns the action priority. |
java.lang.String |
getPropertyDescription(java.lang.String propertyName)
Returns action property description. |
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 |
setEvent(java.lang.Object event)
Sets the event object. |
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. |
void |
setPriority(int value)
Sets the action priority. |
void |
setTriggerErrorMessage(java.lang.String value)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.jscape.inet.mft.workflow.Action |
---|
getDescription, getPropertyDescriptors |
Field Detail |
---|
public static final PropertyDescriptor ACTION_PRIORITY_DESCRIPTOR
public static final PropertyDescriptor TRIGGER_ERROR_MESSAGE_DESCRIPTOR
public static final PropertyDescriptor LOG_ACTION_DESCRIPTOR
public static final int DEFAULT_PRIORITY
Method Detail |
---|
public java.lang.String getPropertyDescription(java.lang.String propertyName)
Action
getPropertyDescription
in interface Action
propertyName
- the property name
public java.lang.String getPropertyExample(java.lang.String propertyName)
Action
getPropertyExample
in interface Action
propertyName
- the property name
public boolean isLogAction()
Action
isLogAction
in interface Action
true
if action should be logged;
false
otherwisepublic void setLogAction(boolean value)
Action
setLogAction
in interface Action
value
- if true
action will be loggedpublic java.lang.String getTriggerName()
Action
getTriggerName
in interface Action
public java.lang.String getResultMessage()
Action
getResultMessage
in interface Action
public java.lang.String getTriggerErrorMessage()
Action
getTriggerErrorMessage
in interface Action
public void setTriggerErrorMessage(java.lang.String value)
public boolean isSuccess()
Action
isSuccess
in interface Action
true
if action was successful executed;
false
otherwisepublic void setEvent(java.lang.Object event)
Action
setEvent
in interface Action
event
- an event objectpublic void setEventContext(java.util.Map<java.lang.String,java.lang.Object> value)
Action
setEventContext
in interface Action
value
- event contextpublic int getPriority()
Action
getPriority
in interface Action
public void setPriority(int value)
Action
setPriority
in interface Action
value
- the action prioritypublic void execute(com.jscape.util.event.EventContext context, java.lang.String triggerName) throws Action.ActionException
Action
execute
in interface Action
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 |