com.aspc.DBObj.Archive

Class TransHeaderLogValues

java.lang.Object

com.aspc.DBObj.Archive.TransHeaderLogValues

public class TransHeaderLogValues
extends java.lang.Object

Helper class for transaction messages.
THREAD MODE: SINGLE-THREADED

Since:

29 September 2006

Author:

alex

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DELIM String delimeter.
static java.lang.String	VALUE_RESTRICTED Restricted value.

Constructor Summary

Constructors

Constructor and Description
TransHeaderLogValues(DataSource ds) Creates a new instance of TransHeaderLogValues

Method Summary

Modifier and Type	Method and Description
TransHeader[]	filterTransactionHeaders(TransHeader[] thArray, java.util.List filters) Returns a filtered list of transaction headers.
TransHeader[]	filterTransactionHeaders(TransHeader[] thArray, java.util.List filters, int chunkSize) Returns a filtered list of transaction headers.
HTMLComponent	generateJournalHTML(DataSource ds, long transId, int transLayerId, HTMLTheme theme, java.lang.String reasonTx, long baseRowUid) Produces HTML for output of transaction id.
DBObject	getCurrentObjectForRow(TransRecord record) Returns the DB Object for the current record.
DBObject	getPreviousObjectForRow(TransRecord record) Returns the DB Object for the previous record.
java.lang.Object	getValue(DBObject dbo, DBField field) Returns a value for the field.
void	init(TransHeader th) Initializes helper with creating archive data sources.
HTMLComponent	transactionHeaderLogComponent(TransHeader th, java.util.List controls) Updates a list of transaction headers with a new reason from filter.
java.lang.String	updateTransactionHeaderLog(TransHeader th, java.util.List controls) Updates a list of transaction headers with a new reason from filter.

Methods inherited from class java.lang.Object

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

Field Detail

VALUE_RESTRICTED

public static final java.lang.String VALUE_RESTRICTED

Restricted value.

See Also:

Constant Field Values

DELIM

public static final java.lang.String DELIM

String delimeter.

See Also:

Constant Field Values

Constructor Detail

TransHeaderLogValues

public TransHeaderLogValues(DataSource ds)

Creates a new instance of TransHeaderLogValues

Parameters:

ds - the root datasource

Method Detail

init

public void init(TransHeader th)

Initializes helper with creating archive data sources.

Parameters:

th - The transaction header

getCurrentObjectForRow

public DBObject getCurrentObjectForRow(TransRecord record)
                                throws java.lang.Exception

Returns the DB Object for the current record.

Parameters:

record - transaction record

Returns:

db object

Throws:

java.lang.Exception - In case of error

getPreviousObjectForRow

public DBObject getPreviousObjectForRow(TransRecord record)
                                 throws java.lang.Exception

Returns the DB Object for the previous record.

Parameters:

record - transaction record

Returns:

db object

Throws:

java.lang.Exception - In case of error

getValue

public java.lang.Object getValue(DBObject dbo,
                                 DBField field)

Returns a value for the field.

Parameters:

dbo - DB Object

field - DB field

Returns:

value

filterTransactionHeaders

public TransHeader[] filterTransactionHeaders(TransHeader[] thArray,
                                              java.util.List filters)
                                       throws java.lang.Exception

Returns a filtered list of transaction headers.

Parameters:

thArray - The array of transaction headers

filters - list of filters

Returns:

filtered array

Throws:

java.lang.Exception - If something went wrong

filterTransactionHeaders

public TransHeader[] filterTransactionHeaders(TransHeader[] thArray,
                                              java.util.List filters,
                                              int chunkSize)
                                       throws java.lang.Exception

Returns a filtered list of transaction headers.

Parameters:

thArray - The array of transaction headers

filters - list of filters

chunkSize - amount of required transaction headers for displaying

Returns:

filtered array

Throws:

java.lang.Exception - If something went wrong

transactionHeaderLogComponent

public final HTMLComponent transactionHeaderLogComponent(TransHeader th,
                                                         java.util.List controls)
                                                  throws java.lang.Exception

Updates a list of transaction headers with a new reason from filter.

Parameters:

th - The transaction header

controls - list of controls

Returns:

The updated reason

Throws:

java.lang.Exception - If something went wrong

updateTransactionHeaderLog

public final java.lang.String updateTransactionHeaderLog(TransHeader th,
                                                         java.util.List controls)
                                                  throws java.lang.Exception

Updates a list of transaction headers with a new reason from filter.

Parameters:

th - The transaction header

controls - list of controls

Returns:

The updated reason

Throws:

java.lang.Exception - If something went wrong

generateJournalHTML

public HTMLComponent generateJournalHTML(DataSource ds,
                                         long transId,
                                         int transLayerId,
                                         HTMLTheme theme,
                                         java.lang.String reasonTx,
                                         long baseRowUid)
                                  throws java.lang.Exception

Produces HTML for output of transaction id.

Parameters:

ds - the data source

transLayerId - the transaction layer.

transId - Transaction to return details of

theme - the theme for this component

reasonTx - optional reason

baseRowUid - optional - if it is a positive number then only details for matching object to be displayed

Returns:

HTMLComponent HTML format

Throws:

java.lang.Exception - If there are errors