|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuditTrailTrigger
Fires when an audit trail event that matches certain criteria is reported to the audit trail. Useful when one flow chart needs to wait for other flow charts to reach milestones or for other flow charts to finish.
The properties on this trigger act as search criteria on the audit trail. The wildcard character "*" can be used in any property. This trigger waits for an audit trail event that matches its properties before firing. When it fires, this trigger returns the details about the specific audit trail event that caused it to fire. Each time this trigger fires, it returns an audit trail event that is no older than its previous firing's audit trail event. The Audit Trail Trigger returns its result in the flow context variable "RESULT". The following table contains more information on accessing and using the result.Flow Context Variable | Field | Java Type | Description |
---|---|---|---|
RESULT | username | java.lang.String | The name of the user that generated the event. For audit trail events that are not generated by user actions, this will be empty. |
RESULT | timestamp | java.util.Date | The Date that the audit trail event was recorded. |
RESULT | actionName | java.lang.String | The name of the trigger or action that generated this audit trail event. For audit trail events that are not associated with an action, this will be empty. |
RESULT | engineName | java.lang.String | The name of the engine that reported this audit trail event. |
RESULT | eventMessage | java.lang.String | This audit trail event's message. |
RESULT | eventName | java.lang.String | This audit trail event's name. |
RESULT | namespace | java.lang.String | The fully-qualified name of the workflow that generated this audit trail event. For audit trail events that are not associated with a workflow, this will be empty. |
FlowContext.sendToAuditTrail(java.lang.String, java.lang.String)
,
Engine.sendToAuditTrail(java.lang.String, java.lang.String)
Nested Class Summary | |
---|---|
static class |
AuditTrailTrigger.AuditTrailTriggerResult
Provides the details of the audit trail event that caused this audit trail trigger to fire. |
Method Summary | |
---|---|
java.lang.String |
getActionName()
Returns the action name filter. |
java.lang.String |
getEngineName()
Returns the engine name filter. |
java.lang.String |
getEventMessage()
Returns the event message filter. |
java.lang.String |
getEventName()
Returns the event name filter. |
java.lang.String |
getNamespace()
Returns the namespace filter. |
java.lang.String |
getUsername()
Returns the username filter. |
void |
setActionName(java.lang.String actionName)
Sets the action name filter. |
void |
setEngineName(java.lang.String engineName)
Sets the engine name filter. |
void |
setEventMessage(java.lang.String eventMessage)
Sets the event message filter. |
void |
setEventName(java.lang.String eventName)
Sets the event name filter. |
void |
setNamespace(java.lang.String namespace)
Sets the namespace filter. |
void |
setUsername(java.lang.String username)
Sets the username filter. |
Methods inherited from interface flux.runtimedatamap.RuntimeDataMap |
---|
getRuntimeDataMap, setRuntimeDataMap |
Method Detail |
---|
java.lang.String getActionName()
AuditTrailTrigger.AuditTrailTriggerResult.actionName
java.lang.String getEngineName()
AuditTrailTrigger.AuditTrailTriggerResult.engineName
java.lang.String getEventMessage()
AuditTrailTrigger.AuditTrailTriggerResult.eventMessage
java.lang.String getEventName()
AuditTrailTrigger.AuditTrailTriggerResult.eventName
java.lang.String getNamespace()
AuditTrailTrigger.AuditTrailTriggerResult.namespace
java.lang.String getUsername()
AuditTrailTrigger.AuditTrailTriggerResult.username
void setActionName(java.lang.String actionName)
actionName
- The action name filter.AuditTrailTrigger.AuditTrailTriggerResult.actionName
void setEngineName(java.lang.String engineName)
engineName
- The engine name filter.AuditTrailTrigger.AuditTrailTriggerResult.engineName
void setEventMessage(java.lang.String eventMessage)
eventMessage
- The event message filter.AuditTrailTrigger.AuditTrailTriggerResult.eventMessage
void setEventName(java.lang.String eventName)
eventName
- The event name filter.AuditTrailTrigger.AuditTrailTriggerResult.eventName
void setNamespace(java.lang.String namespace)
namespace
- The namespace filter.AuditTrailTrigger.AuditTrailTriggerResult.namespace
void setUsername(java.lang.String username)
username
- The username filter.AuditTrailTrigger.AuditTrailTriggerResult.username
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |