OpenScape
V3.2, Revision 044 20100322

com.siemens.symphonia.bcom.bcommon.external
Interface DeviceListener

All Superinterfaces:
RegistrationListener
All Known Subinterfaces:
ServerDeviceListener
All Known Implementing Classes:
DeviceAdapter, ServerDeviceListenerImpl

public interface DeviceListener
extends RegistrationListener

Notification of connection oriented events.

Call-back interface to be implemented. It provides notifications of changes on device level.

All methods have for the second parameter a communication endpoint object ComEndpoint. This parameter specifies for which endpoint the event is deliviered. This is either a BComUser or a DeviceEndpoint.
A precondition for receiveing events on an endpoint is to have subscribed for. This can be done by the various subscription methods like BCom.addDeviceListenerForUser(Set,DeviceListener) or BCom.addDeviceListenerForDevice(Set, DeviceListener).


Method Summary
 void onCTIControlDown(DeviceEndpoint deviceEndpoint, ComEndpoint comEndpoint)
          Lost control link.
 void onForwardingChanged(DeviceEndpoint deviceEndpoint, ComEndpoint comEndpoint)
          Forwarding target has been changed.
 void onInService(DeviceEndpoint deviceEndpoint, ComEndpoint comEndpoint)
          Device is in service.
 void onOutOfService(DeviceEndpoint deviceEndpoint, ComEndpoint comEndpoint)
          Device is out of service.
 
Methods inherited from interface com.siemens.symphonia.bcom.bcommon.external.RegistrationListener
onRegistrationComplete
 

Method Detail

onInService

void onInService(DeviceEndpoint deviceEndpoint,
                 ComEndpoint comEndpoint)
Device is in service.

The device given by the parameter deviceEndpoint is available and may be used. Receiving this event is a precondition to invoke requests (e.g. connect(String)) on the concerned device respective ONS device of a user.

Parameters:
deviceEndpoint - device which is now in service.
comEndpoint - target of event notification.

onOutOfService

void onOutOfService(DeviceEndpoint deviceEndpoint,
                    ComEndpoint comEndpoint)
Device is out of service.

The device given by the parameter deviceEndpoint is no more available. Requests may not be invoked anymore.

NOTE:
On a HiPath 8000 the device of type PHONE might go out of service and it is still possible to initiate communications as long as the preferred device is set to another device. Only when the device of type VIRTUAL fails no more communications are possible.

Parameters:
deviceEndpoint - device which is out of service.
comEndpoint - target of event notification.

onCTIControlDown

void onCTIControlDown(DeviceEndpoint deviceEndpoint,
                      ComEndpoint comEndpoint)
Lost control link.

The control link to the communication system of the device given by the parameter deviceEndpoint has been lost. Therefore the service state (in service or out of service) can't be determined.

It is currently not possible to invoke any requests.

When the control link is re-established an onInService or onOutOfService event will be sent.

Parameters:
deviceEndpoint - device which lost control link.
comEndpoint - target of event notification.

onForwardingChanged

void onForwardingChanged(DeviceEndpoint deviceEndpoint,
                         ComEndpoint comEndpoint)
Forwarding target has been changed.

A forwarding target of the device given by the parameter deviceEndpoint has been changed. The new forwarding targets can be retrieved from the event using com.siemens.symphonia.bcom.bcommon.external.VoiceDevice#getForwarding()

Parameters:
deviceEndpoint - device where the forwarding data has been changed.
comEndpoint - target of event notification. TODO: JAVADOC Review

OpenScape
V3.2, Revision 044 20100322

Copyright (c) 2007 Siemens Enterprise Communications, Germany
All rights reserved.

This software is the confidential and proprietary information of Siemens Enterprise Communications, Germany