flux

Interface KeyFlowContext

All Superinterfaces:

AuditTrailFlowContext, FlowContext, java.io.Serializable, VariableManager

public interface KeyFlowContext
extends FlowContext

Provides the user-defined key to a job listener that was specified when the flow chart was created.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getKey() Returns the user-defined key that is associated with this listener.

Methods inherited from interface flux.FlowContext

getDatabaseConnection, getErrorResult, getId, getLogger, getRaisedSignals, getRawDatabaseConnection, getStatus, isExpedited, isInterrupted, isSignalRaised, isTimedOut, isTransient, putTransient, returnTransient, returnTransient, sendToAuditTrail, setStatus, substitute, willReturnTransient

Methods inherited from interface flux.audittrail.AuditTrailFlowContext

getActionName, getEngine, getFlowChart, getLastResult, getUsername

Methods inherited from interface flux.VariableManager

clear, contains, get, getNames, put, put, put, put, put, put, put, put, put, putAll, remove, size

Method Detail

getKey

java.lang.Object getKey()
                 throws EngineException

Returns the user-defined key that is associated with this listener.

Returns:

The user-defined key that is associated with this listener.

Throws:

EngineException - If a system error occurs.