com.cisco.provisioning.cpe.events
Interface DeviceEvent

All Superinterfaces:

Externalizable, ProvAPIEvent, Serializable

public interface DeviceEvent
extends ProvAPIEvent

The interface that defines the object to be returned as a result of a DeviceEvent notification.

Method Summary

DeviceID	getDeviceID(KeyType type) Return Device ID based the the specified KeyType
DeviceID[]	getDeviceIDs() Returns the array of DeviceID (eg, MACAddress).
String	getDeviceIP() Returns the Device IP Address.
String	getDeviceProvGroup() Returns the Device's provisioning group (or null).
DeviceType	getDeviceType() Returns the Device's DeviceType (or null).
String	getNewData() Returns the old data for the event.
String	getOldData() Returns the old data for the event.
String	getReceivedStatus() Returns the status received from the device.

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

getID, getSource, setID, setSource, toString

Methods inherited from interface java.io.Externalizable

readExternal, writeExternal

Method Detail

getDeviceIDs

DeviceID[] getDeviceIDs()

Returns the array of DeviceID (eg, MACAddress).

Returns:

the array of DeviceID (MACAddress).

getDeviceID

DeviceID getDeviceID(KeyType type)

Return Device ID based the the specified KeyType

Parameters:

type - The KeyType indicate the type of DeviceID

Returns:

the DeviceID from the specified KeyType

getDeviceIP

String getDeviceIP()

Returns the Device IP Address.

Returns:

the device IP Address.

getOldData

String getOldData()

Returns the old data for the event. Semantics depend on eventID:

eventID	data
NEW_UNPROV_DEVICE	null
NEW_PROV_DEVICE	null
CHANGED_IP	null
ROAMING_DEVICE	old Prov Group
CHANGED_COS	old Class of Service
DELETED_DEVICE	deleted device ID
RECEIVED_STATUS	null

Returns:

the old data for the device.

getNewData

String getNewData()

Returns the old data for the event. Semantics depend on eventID:

eventID	data
NEW_UNPROV_DEVICE	new device ID
NEW_PROV_DEVICE	new device ID
CHANGED_IP	new IP Address
ROAMING_DEVICE	new Prov Group
CHANGED_COS	new Class of Service
DELETED_DEVICE	null
RECEIVED_STATUS	null

Returns:

the new data for the device.

getDeviceProvGroup

String getDeviceProvGroup()

Returns the Device's provisioning group (or null).

Returns:

the device's provisioning group.

getReceivedStatus

String getReceivedStatus()

Returns the status received from the device. Will be null if the sub-type isn't DeviceListener.RECEIVED_STATUS.

Returns:

the status received from the device.

getDeviceType

DeviceType getDeviceType()

Returns the Device's DeviceType (or null).

Returns:

the device's DeviceType.