com.rhi.architecture.parc
Interface Record

All Known Implementing Classes:

AbstractRecord

public interface Record

Record type used for data being passed through the Pipeline.

Since:

1.0

Author:

Pete McKinstry

Method Summary

void	addError(Error error) Add error to this record.
java.util.List	getErrors() Return the list of errors attached to this record.
java.lang.Object	getSourceKey() Return the source id of this record.
boolean	isErrored() Is the Record in an errored state.
boolean	isValid() Is the Record valid.
java.lang.String	toString() Return a String representation of this Record.

Method Detail

getSourceKey

public java.lang.Object getSourceKey()

Return the source id of this record. This is used to track records through the system so that effective auditing can be done on records when they reach the end of the pipeline.

Returns:

Object - the key for the source record. It may be the actual source record itself.

Since:

1.0

isValid

public boolean isValid()

Is the Record valid. What isValid() really means, is up to the concrete record class. Normally, isValid() & isErrored() should return opposite values.

Returns:

boolean True/False

Since:

1.0

isErrored

public boolean isErrored()

Is the Record in an errored state. What isErrored() really means is up to the concrete record class. Normally isValid() and isErrored() should return opposite boolean values.
If isErrored() returns true, the getErrors() method should return a List w/ size() > 1. If the error list is empty, isErrored should be false.

Returns:

boolean True/False

Since:

1.0

getErrors

public java.util.List getErrors()

Return the list of errors attached to this record. Allows a cummulative process for attaching errors to the record where the first error in the list is the first error found during processing.

Returns:

List - the list of errors attached to this record.

Since:

1.0

addError

public void addError(Error error)

Add error to this record.

Parameters:

error - msg

Since:

1.0

toString

public java.lang.String toString()

Return a String representation of this Record.

Returns:

boolean True/False

Since:

1.0