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(Vector request)
          This method adds a new transaction to the store queue.
 Enumeration findAllErrorTransactions()
          This method will find all the transactions on the error queue.
 Enumeration findAllStoredTransactions()
          This method will find all the transactions on the store queue
 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
 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
 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

void addTransactionToCompleted(int sequenceNo)
                               throws ProcessingErrorException,
                                      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
RemoteException

addTransactionToError

void addTransactionToError(int sequenceNo)
                           throws ProcessingErrorException,
                                  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
RemoteException

createStoredTransaction

StoreTransaction createStoredTransaction(Vector request)
                                         throws ProcessingErrorException,
                                                RemoteException
This method adds a new transaction to the store queue.

Parameters:
request - vector
Returns:
the created StoreTransaction object
Throws:
ProcessingErrorException
RemoteException

findAllErrorTransactions

Enumeration findAllErrorTransactions()
                                     throws ProcessingErrorException,
                                            RemoteException
This method will find all the transactions on the error queue.

Returns:
an enumeration of transaction on the error queue
Throws:
ProcssingErrorException
RemoteException
ProcessingErrorException

findAllStoredTransactions

Enumeration findAllStoredTransactions()
                                      throws ProcessingErrorException,
                                             RemoteException
This method will find all the transactions on the store queue

Returns:
an enumeration of transaction on the store queue
Throws:
ProcssingErrorException
RemoteException
ProcessingErrorException

findAllSuccessfulTransactions

Enumeration findAllSuccessfulTransactions()
                                          throws ProcessingErrorException,
                                                 RemoteException
This method will find all the transactions on the successful queue.

Returns:
an enumeration of transaction on the successful queue
Throws:
ProcssingErrorException
RemoteException
ProcessingErrorException

findNextStoredTransaction

DataPacket findNextStoredTransaction()
                                     throws ProcessingErrorException,
                                            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
RemoteException
ProcessingErrorException

findStoredTransactionBySequenceNo

DataPacket findStoredTransactionBySequenceNo(int sequenceNo)
                                             throws ProcessingErrorException,
                                                    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
RemoteException

findStoredTransactionsInTimePeriod

Enumeration findStoredTransactionsInTimePeriod(long startTime,
                                               long endTime)
                                               throws ProcessingErrorException,
                                                      ValidationException,
                                                      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
RemoteException
ValidationException

isStoreEmpty

boolean isStoreEmpty()
                     throws ProcessingErrorException,
                            RemoteException
This method will determine if the store has transactions on it

Returns:
true if the store is empty, otherwise false
Throws:
ProcessingErrorException
RemoteException

nextStoredTransactionBatch

String nextStoredTransactionBatch()
                                  throws ProcessingErrorException,
                                         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
RemoteException
ProcessingErrorException

removeTransactionFromError

void removeTransactionFromError(int sequenceNo)
                                throws ProcessingErrorException,
                                       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
RemoteException

removeTransactionFromSuccessful

void removeTransactionFromSuccessful(int sequenceNo)
                                     throws ProcessingErrorException,
                                            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
RemoteException

setOffline

void setOffline()
                throws ProcessingErrorException,
                       RemoteException
This method will set all host destinations offline

Throws:
ProcessingErrorException
RemoteException

setOnline

void setOnline()
               throws ProcessingErrorException,
                      RemoteException
This method will set all host destinations online

Throws:
ProcessingErrorException
RemoteException


Copyright © 2005, 2007, Oracle. All rights reserved.