com.cisco.provisioning.cpe.events
Class BatchAdapter

java.lang.Object
  extended by com.cisco.provisioning.cpe.events.BatchAdapter
All Implemented Interfaces:
BatchListener, ProvAPIEventListener

public abstract class BatchAdapter
extends Object
implements BatchListener

An abstract class that provides no-op definitions of all methods in the BatchListener interface. Users must extend this class, and then implement the methods for the desired BatchEvent sub-event notifications.


Field Summary
 
Fields inherited from interface com.cisco.provisioning.cpe.events.BatchListener
BATCH_COMPLETE
 
Constructor Summary
BatchAdapter()
           
 
Method Summary
 void completion(BatchEvent ev)
          The method invoked when a BatchEvent arrives.
 boolean getOneShot()
          Gets oneShot mode value, specifying whether or not the listener is registered for just one occurrence of the Event.
 void setOneShot(boolean flg)
          Sets oneShot mode, specifying that the registration request is for just one occurrence of the Event.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BatchAdapter

public BatchAdapter()
Method Detail

completion

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

Specified by:
completion in interface BatchListener
Parameters:
ev - The object containing the BatchEvent data.

getOneShot

public boolean getOneShot()
Gets oneShot mode value, specifying whether or not the listener is registered for just one occurrence of the Event.

Specified by:
getOneShot in interface ProvAPIEventListener
Returns:
true if oneShot mode has been set

setOneShot

public void setOneShot(boolean flg)
Sets oneShot mode, specifying that the registration request is for just one occurrence of the Event.

Specified by:
setOneShot in interface ProvAPIEventListener
Parameters:
flg - true if oneShot mode is being set