atg.service.pipeline
Interface PipelineResult

All Known Implementing Classes:

PipelineResultImpl

public interface PipelineResult

An interface which provides access to the error data for a pipeline execution.

See Also:

PipelineChain, PipelineProcessor, PipelineResultImpl

Field Summary

static java.lang.String

CLASS_VERSION

Method Summary

void	addError(java.lang.Object pKey, java.lang.Object pError) Adds an error object mapped to pKey.
void	copyInto(PipelineResult pResult) Copies the data from one PipelineResult to another.
java.lang.Object	getError(java.lang.Object pKey) Returns the object associated with pKey.
java.lang.Object[]	getErrorKeys() Returns an array of key objects which exist in the PipelineResultable.
java.lang.Object[]	getErrors() Returns an array of error objects which exist in the PipelineResultable.
boolean	hasErrors() Returns true if at least one error object exists, false otherwise.
void	removeError(java.lang.Object pKey) Removes the error object mapped to pKey from the PipelineResultable.

Field Detail

CLASS_VERSION

static final java.lang.String CLASS_VERSION

See Also:

Constant Field Values

Method Detail

getError

java.lang.Object getError(java.lang.Object pKey)

Returns the object associated with pKey. null should be returned if pKey does not exist.

addError

void addError(java.lang.Object pKey,
              java.lang.Object pError)

Adds an error object mapped to pKey.

getErrorKeys

java.lang.Object[] getErrorKeys()

Returns an array of key objects which exist in the PipelineResultable.

getErrors

java.lang.Object[] getErrors()

Returns an array of error objects which exist in the PipelineResultable.

hasErrors

boolean hasErrors()

Returns true if at least one error object exists, false otherwise.

removeError

void removeError(java.lang.Object pKey)

Removes the error object mapped to pKey from the PipelineResultable.

copyInto

void copyInto(PipelineResult pResult)

Copies the data from one PipelineResult to another.