com.bankframe.ei.txnhandler.storeandforward.storequeue
Interface StoreQueue

All Known Subinterfaces:

StoreQueue

public interface StoreQueue

The StoreQueue interface.

Method Summary

void	addTransactionToCompleted(int sequenceNo) This method removes the given transaction form the store queue and adds it to the successfully completed queue
void	addTransactionToError(int sequenceNo) This method removes the given transaction form the store queue and adds it to the error queue
StoreTransaction	createStoredTransaction(java.util.Vector request) This method adds a new transaction to the store queue.
java.util.Enumeration	findAllErrorTransactions() This method will find all the transactions on the error queue.
java.util.Enumeration	findAllStoredTransactions() This method will find all the transactions on the store queue
java.util.Enumeration	findAllSuccessfulTransactions() This method will find all the transactions on the successful queue.
DataPacket	findNextStoredTransaction() This method will return the transaction at the head of the store queue
DataPacket	findStoredTransactionBySequenceNo(int sequenceNo) This method performs a lookup on the Store queue by sequenceNo
java.util.Enumeration	findStoredTransactionsInTimePeriod(long startTime, long endTime) This method performs a lookup on the store queue for a given time period
boolean	isStoreEmpty() This method will determine if the store has transactions on it
java.lang.String	nextStoredTransactionBatch() This method will return a batch of transactions using the BankframeResource.properties file to get the no.
void	removeTransactionFromError(int sequenceNo) This method removes the transaction from the error queue with the given sequence number.
void	removeTransactionFromSuccessful(int sequenceNo) This method removes the transaction from the Successful queue with the given sequenceNo.
void	setOffline() This method will set all host destinations offline
void	setOnline() This method will set all host destinations online

Method Detail

addTransactionToCompleted

public void addTransactionToCompleted(int sequenceNo)
                               throws ProcessingErrorException,
                                      java.rmi.RemoteException

This method removes the given transaction form the store queue and adds it to the successfully completed queue

Parameters:

sequenceNo - A valid sequence number of a completed transaction.

Throws:

ProcessingErrorException

java.rmi.RemoteException

addTransactionToError

public void addTransactionToError(int sequenceNo)
                           throws ProcessingErrorException,
                                  java.rmi.RemoteException

This method removes the given transaction form the store queue and adds it to the error queue

Parameters:

sequenceNo - A valid sequence number of transaction which returned an error.

Throws:

ProcessingErrorException

java.rmi.RemoteException

createStoredTransaction

public StoreTransaction createStoredTransaction(java.util.Vector request)
                                         throws ProcessingErrorException,
                                                java.rmi.RemoteException

This method adds a new transaction to the store queue.

Returns:

the created StoreTransaction object

Throws:

ProcessingErrorException

java.rmi.RemoteException

findAllErrorTransactions

public java.util.Enumeration findAllErrorTransactions()
                                               throws ProcessingErrorException,
                                                      java.rmi.RemoteException

This method will find all the transactions on the error queue.

Returns:

an enumeration of transaction on the error queue

Throws:

ProcssingErrorException

java.rmi.RemoteException

ProcessingErrorException

findAllStoredTransactions

public java.util.Enumeration findAllStoredTransactions()
                                                throws ProcessingErrorException,
                                                       java.rmi.RemoteException

This method will find all the transactions on the store queue

Returns:

an enumeration of transaction on the store queue

Throws:

ProcssingErrorException

java.rmi.RemoteException

ProcessingErrorException

findAllSuccessfulTransactions

public java.util.Enumeration findAllSuccessfulTransactions()
                                                    throws ProcessingErrorException,
                                                           java.rmi.RemoteException

This method will find all the transactions on the successful queue.

Returns:

an enumeration of transaction on the successful queue

Throws:

ProcssingErrorException

java.rmi.RemoteException

ProcessingErrorException

findNextStoredTransaction

public DataPacket findNextStoredTransaction()
                                     throws ProcessingErrorException,
                                            java.rmi.RemoteException

This method will return the transaction at the head of the store queue

Returns:

a DataPacket representation of the transaction at the head of the queue

Throws:

ProcssingErrorException

java.rmi.RemoteException

ProcessingErrorException

findStoredTransactionBySequenceNo

public DataPacket findStoredTransactionBySequenceNo(int sequenceNo)
                                             throws ProcessingErrorException,
                                                    java.rmi.RemoteException

This method performs a lookup on the Store queue by sequenceNo

Parameters:

sequenceNo - A valid SEQUENCE_NO of a stored transaction.

Returns:

the DataPacket representation of the transaction with the given sequence number

Throws:

ProcessingErrorException

RemoteExcpetion

java.rmi.RemoteException

findStoredTransactionsInTimePeriod

public java.util.Enumeration findStoredTransactionsInTimePeriod(long startTime,
                                                                long endTime)
                                                         throws ProcessingErrorException,
                                                                ValidationException,
                                                                java.rmi.RemoteException

This method performs a lookup on the store queue for a given time period

Parameters:

startTime - time to start searching from.

endTime - time to end searching to.

Returns:

an enumeration of transaction store in the given time period

Throws:

ProcessingErrorException

java.rmi.RemoteException

ValidationException

isStoreEmpty

public boolean isStoreEmpty()
                     throws ProcessingErrorException,
                            java.rmi.RemoteException

This method will determine if the store has transactions on it

Returns:

true if the store is empty, otherwise false

Throws:

ProcessingErrorException

java.rmi.RemoteException

nextStoredTransactionBatch

public java.lang.String nextStoredTransactionBatch()
                                            throws ProcessingErrorException,
                                                   java.rmi.RemoteException

This method will return a batch of transactions using the BankframeResource.properties file to get the no. of transactions for a batch.

Returns:

a Vector containing DataPacket representations of the transactions in the batch.

Throws:

ProcssingErrorException

java.rmi.RemoteException

ProcessingErrorException

removeTransactionFromError

public void removeTransactionFromError(int sequenceNo)
                                throws ProcessingErrorException,
                                       java.rmi.RemoteException

This method removes the transaction from the error queue with the given sequence number.

Parameters:

sequenceNo - A valid sequence number of a stored transaction.

Throws:

ProcessingErrorException

java.rmi.RemoteException

removeTransactionFromSuccessful

public void removeTransactionFromSuccessful(int sequenceNo)
                                     throws ProcessingErrorException,
                                            java.rmi.RemoteException

This method removes the transaction from the Successful queue with the given sequenceNo.

Parameters:

sequenceNo - A valid sequence number of a stored transaction.

Throws:

ProcessingErrorException

java.rmi.RemoteException

setOffline

public void setOffline()
                throws ProcessingErrorException,
                       java.rmi.RemoteException

This method will set all host destinations offline

Throws:

ProcessingErrorException

java.rmi.RemoteException

setOnline

public void setOnline()
               throws ProcessingErrorException,
                      java.rmi.RemoteException

This method will set all host destinations online

Throws:

ProcessingErrorException

java.rmi.RemoteException