flux.audittrail.server
Interface AbstractServerEvent

All Superinterfaces:

AbstractAuditTrailEvent

All Known Subinterfaces:

ActionTimeoutEvent, DeferringExecutionFlowEvent, EndingRunEvent, EnteringActionEvent, EnteringTriggerEvent, ExecutingActionEvent, ExitingActionEvent, ExitingActionOnErrorEvent, ExitingActionOnSignalEvent, ExitingActionOnTimeoutEvent, ExitingTriggerEvent, ExitingTriggerOnErrorEvent, ExitingTriggerOnSignalEvent, ExitingTriggerOnTimeoutEvent, ExitingTriggerWithoutFiringEvent, FinishingExecutionFlowEvent, FinishingFlowChartEvent, StartingExecutionFlowEvent, StartingRunEvent

public interface AbstractServerEvent
extends AbstractAuditTrailEvent

Abstract interface for significant server side events that are logged to the audit trail.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

AuditTrailFlowContext	getFlowContext() Returns the flow context for the current flow chart.
java.lang.Long	getFlowContextId() Returns an optional, unique ID that identifies the execution flow context associated with this audit trail event.

Methods inherited from interface flux.audittrail.AbstractAuditTrailEvent

getEngineName, getName

Method Detail

getFlowContext

AuditTrailFlowContext getFlowContext()

Returns the flow context for the current flow chart.

Directly modifying the returned flow context has no effect, with one caveat. The current flow chart's flow context is cloned before it is returned by this method call. Note that any variable references stored within any VariableManager objects within the flow context that are not marked as Cloneable are copied into the cloned flow context directly, without being cloned. Caution should be used to make sure these non-cloned variables are not modified.

All VariableManager variables generated by the engine and the built-in triggers and actions are either cloneable or immutable. It is possible, however, that a variable introduced by the programmer may not be cloneable, in which case care should be exercised to make sure that variable is not modified within the context of the audit trail.

Returns:

The flow context for the current flow chart.

getFlowContextId

java.lang.Long getFlowContextId()

Returns an optional, unique ID that identifies the execution flow context associated with this audit trail event.

Returns:

An optional, unique ID that identifies the execution flow context associated with this audit trail event.