com.vordel.circuit

Class CircuitReference

java.lang.Object

com.vordel.circuit.CircuitReference

Direct Known Subclasses:

SoftCircuitReference

public class CircuitReference
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
boolean	isEnabled
java.lang.String	label
ESPK	pk

Constructor Summary

Constructors

Constructor and Description
CircuitReference(ESPK ref)

Method Summary

Modifier and Type	Method and Description
Circuit	getCircuit(Message m) Call this from the processor.
ESPK	getCircuitPK()
java.lang.Object	getContext() For tracking the call path, retrieve the indexing information we used to lookup the circuit to execute.
void	setCircuit(Circuit circuit)
void	setEnabled(boolean enabled)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

pk

public ESPK pk

label

public java.lang.String label

isEnabled

public boolean isEnabled

Constructor Detail

CircuitReference

public CircuitReference(ESPK ref)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

setEnabled

public void setEnabled(boolean enabled)

getCircuit

public Circuit getCircuit(Message m)
                   throws CircuitAbortException

Call this from the processor.

Parameters:

m - The Message to aid in locating the relevant Circuit this reference points to.

Returns:

The Circuit this object references.

Throws:

CircuitAbortException - If the referring Circuit cannot be identified.

getCircuitPK

public ESPK getCircuitPK()

setCircuit

public void setCircuit(Circuit circuit)

getContext

public java.lang.Object getContext()

For tracking the call path, retrieve the indexing information we used to lookup the circuit to execute. In the simple case, it will be the ESPK. For a soft reference, return the property value we used to indirect to the circuit.

Returns:

The index we used to lookup the circuit.