com.cisco.provisioning.cpe.events
Interface BatchListener

All Superinterfaces:

ProvAPIEventListener

All Known Implementing Classes:

BatchAdapter

public interface BatchListener
extends ProvAPIEventListener

The Listener interface for BatchEvents. The addBatchListener method on the PACEConnection instance may be used to register BatchListener instances.

Sample Usage:

      // Implement BatchListener interface
      public class MyBatchListener implements  BatchListener
      {
          ...
      }

      // Create an instance of BatchEventQualifier and
      // filter by batchID.
      // [You may also use an instance of QualifyAll
      // that performs no filtering.]
      myQualifier = new BatchEventQualifier();
      // Filter it to a specific batch ID
      myQualifier.setBatchID("TEST_BATCH_01");

      // Register batch listener using PACEConnection
      ...
      conn.addBatchListener(new MyBatchListener(), // BatchListener
                            myQualifier // Qualifier
                           );
       ...
 

Field Summary

static int

BATCH_COMPLETE Event ID that indicates the BATCH_COMPLETE sub-event type of the BatchEvent.

Method Summary

void	completion(BatchEvent ev) The method invoked when a BatchEvent arrives.

Methods inherited from interface com.cisco.provisioning.cpe.events.ProvAPIEventListener

getOneShot, setOneShot

Field Detail

BATCH_COMPLETE

static final int BATCH_COMPLETE

Event ID that indicates the BATCH_COMPLETE sub-event type of the BatchEvent. This indicates that a batch has completed.

See Also:

Constant Field Values

Method Detail

completion

void completion(BatchEvent ev)

The method invoked when a BatchEvent arrives.

Parameters:

ev - the object containing the BatchEvent data.