atg.service.pipeline
Class PipelineLink

java.lang.Object
  atg.service.pipeline.PipelineLink

All Implemented Interfaces:

java.io.Serializable

public class PipelineLink
extends java.lang.Object
implements java.io.Serializable

This class contains a reference to a PipelineProcessor and a mapping of return values to next processors. It is used by the PipelineChain to call the runProcess() method on the component and then get the reference to the next processor based on the return value.

See Also:

PipelineChain, PipelineProcessor, Serialized Form

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

java.lang.String	getId() Returns the linkId.
PipelineLink	getNextLink(int pRetCode) Returns the PipelineLink object mapped to aRetCode.
PipelineLink[]	getNextLinks(int[] pRetCodes) Returns an array of PipelineLink objects that are mapped to the given return codes.
PipelineProcessor	getProcessor() Returns the PipelineProcessor object which the link represents.
java.lang.String	getProcessorClass() Returns the classname associated with our processor.
java.lang.String	getProcessorMode() Returns the processor mode for the link.
int[]	getProcessorRetCodes() Gets the retCodes defined by our processor.
int[]	getRetCodes() Returns an array of return codes that are mapped in the PipelineLink.
int	getTransactionMode() Returns the transaction mode for this PipelineLink.
void	setTransactionMode(int pMode) Sets the transaction mode for the link.

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Method Detail

getId

public final java.lang.String getId()

Returns the linkId. This is the name of the PipelineLink object.

getTransactionMode

public int getTransactionMode()

Returns the transaction mode for this PipelineLink. If one has not been explicitly defined, then the value returned will be the default for the PipelineChain.

setTransactionMode

public void setTransactionMode(int pMode)
                        throws LockChainException

Sets the transaction mode for the link.

Throws:

LockChainException

getProcessor

public PipelineProcessor getProcessor()

Returns the PipelineProcessor object which the link represents.

getProcessorMode

public java.lang.String getProcessorMode()

Returns the processor mode for the link.

getProcessorClass

public java.lang.String getProcessorClass()

Returns the classname associated with our processor.

getProcessorRetCodes

public int[] getProcessorRetCodes()

Gets the retCodes defined by our processor.

getNextLink

public PipelineLink getNextLink(int pRetCode)

Returns the PipelineLink object mapped to aRetCode. If aRetCode is not mapped, then null is returned.

getNextLinks

public PipelineLink[] getNextLinks(int[] pRetCodes)

Returns an array of PipelineLink objects that are mapped to the given return codes. The values in the return array correspond to the return values that are passed in aRetCodes.

getRetCodes

public int[] getRetCodes()

Returns an array of return codes that are mapped in the PipelineLink.