org.kuali.ole.sys.batch

Class FlatFileTransactionInformation

java.lang.Object

org.kuali.ole.sys.batch.FlatFileTransactionInformation

public final class FlatFileTransactionInformation
extends Object

An encapsulator for validation information associated with a logical file/top level header

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlatFileTransactionInformation.EntryType
static class	FlatFileTransactionInformation.ResultCode

Constructor Summary

Constructors

Constructor and Description
FlatFileTransactionInformation() Constructs a FlatFileTransactionInformation
FlatFileTransactionInformation(String flatFileDataIdentifier) Constructs a FlatFileTransactionInformation

Method Summary

Methods

Modifier and Type	Method and Description
void	addErrorMessage(String message) Adds an error message for this transaction
void	addInfoMessage(String message) Adds an informative message for this transaction
void	addWarnMessage(String message) Adds a warning message for this transaction
static String	getEntryTypeString(FlatFileTransactionInformation.EntryType type) Creates a String representation for the given entry type
String	getFlatFileDataIdentifier()
List<String[]>	getMessages()
FlatFileTransactionInformation.ResultCode	getResult()
static String	getResultCodeString(FlatFileTransactionInformation.ResultCode resultCode) Creates a String representation for the given result code
String	getResultString()
void	setErrorResult() Sets the result code to error for the transaction
void	setFailureResult() Sets the result code to failure for the transaction
void	setFlatFileDataIdentifier(String flatFileDataIdentifier) Sets the identifier for the flat file this is associated with
void	setSuccessResult() Declares the logical file a success!

Methods inherited from class java.lang.Object

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

Constructor Detail

FlatFileTransactionInformation

public FlatFileTransactionInformation()

Constructs a FlatFileTransactionInformation

FlatFileTransactionInformation

public FlatFileTransactionInformation(String flatFileDataIdentifier)

Constructs a FlatFileTransactionInformation

Parameters:

flatFileDataIdentifier - the identifier for the file the business object this object holds messages for was parsed from

Method Detail

getEntryTypeString

public static String getEntryTypeString(FlatFileTransactionInformation.EntryType type)

Creates a String representation for the given entry type

Parameters:

type - the entry type to get a String representation for

Returns:

the String representation

getResultCodeString

public static String getResultCodeString(FlatFileTransactionInformation.ResultCode resultCode)

Creates a String representation for the given result code

Parameters:

type - the resultCode to get a String representation for

Returns:

the String representation

getResult

public FlatFileTransactionInformation.ResultCode getResult()

Returns:

returns the resultCode for this transaction information object

getResultString

public String getResultString()

Returns:

returns a String representation of the resultCode for this transaction information object

setSuccessResult

public void setSuccessResult()

Declares the logical file a success!

setFailureResult

public void setFailureResult()

Sets the result code to failure for the transaction

setErrorResult

public void setErrorResult()

Sets the result code to error for the transaction

getFlatFileDataIdentifier

public String getFlatFileDataIdentifier()

Returns:

the identifier for the flat file this is associated with

setFlatFileDataIdentifier

public void setFlatFileDataIdentifier(String flatFileDataIdentifier)

Sets the identifier for the flat file this is associated with

Parameters:

flatFileDataIdentifier - the identifier for the flat file this is associated with

getMessages

public List<String[]> getMessages()

Returns:

the full List of messages associated with the transaction this is associated with

addErrorMessage

public void addErrorMessage(String message)

Adds an error message for this transaction

Parameters:

message - the message to explain the error

addInfoMessage

public void addInfoMessage(String message)

Adds an informative message for this transaction

Parameters:

message - the informative message, hopefully something more explanatory than this javadoc

addWarnMessage

public void addWarnMessage(String message)

Adds a warning message for this transaction

Parameters:

message - the warning message