com.ibm.etill.ldbcardcassette
Class LdbCardBatch.AutoCloseWorkItem

com.ibm.etill.ldbcardcassette.LdbCardBatch.AutoCloseWorkItem
Enclosing class:
LdbCardBatch

public final class LdbCardBatch.AutoCloseWorkItem

The AutoCloseWorkItem object is used to automatically close an open batch as soon as possible. f day (specified in minutes after midnight). When constructed, it automatically schedules itself using the framework's timer queue. When the scheduled time is reached, the framework gives this object to the next available service thread by placing this object on the service queue.


Field Summary
private  com.ibm.etill.framework.cassette.BatchCloseRequest objRequest
          This AutoCloseWorkItem attribute contains a batch close request for the batch that is to be automatically closed.
 
Constructor Summary
LdbCardBatch.AutoCloseWorkItem(com.ibm.etill.framework.cassette.BatchCloseRequest argRequest, com.ibm.etill.framework.cassette.Cassette argCassette)
          This constructor initializes this work item and adds it to the frameworks service thread queue.
 
Method Summary
 void doYourWork()
          This method is called by the framework service thread to perform the work assigned to this work item.
 

Field Detail

objRequest

private com.ibm.etill.framework.cassette.BatchCloseRequest objRequest
This AutoCloseWorkItem attribute contains a batch close request for the batch that is to be automatically closed. It is used by the parent class to determine what framework locks must be obtained by the thread before it is safe to call the doYourWork() method. It is also used by this object to obtain references to the framework and cassette objects needed to perform the close request.
Constructor Detail

LdbCardBatch.AutoCloseWorkItem

public LdbCardBatch.AutoCloseWorkItem(com.ibm.etill.framework.cassette.BatchCloseRequest argRequest,
                                      com.ibm.etill.framework.cassette.Cassette argCassette)
                               throws com.ibm.etill.framework.payapi.ETillAbortOperation
This constructor initializes this work item and adds it to the frameworks service thread queue.
Parameters:
argRequest - - a BatchCloseRequest for the batch to be closed automatically.
argCassette - - the cassette that owns the batch.
Throws:
ETillAbortOperation - - any failure results in this exception.
Method Detail

doYourWork

public void doYourWork()
                throws com.ibm.etill.framework.payapi.ETillAbortOperation
This method is called by the framework service thread to perform the work assigned to this work item. Before calling this method, the service thread will obtain all the required locks. The list of required locks is determined by the Request object (in this case a BatchCloseRequest object) that was specified when this work item was constructed. See the framework Javadoc for the BatchCloseRequest object to see what locks are obtained.
Throws:
ETillAbortOperation - - any failure results in this exception.