OpenScape
V3.2, Revision 044 20100322

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

All Known Subinterfaces:
InitiationCause, TerminationCause
All Known Implementing Classes:
BComCauseImpl, InitiationCauseImpl, TerminationCauseImpl

public interface BComCause

Provide context information for initiated or terminated communications.

When a communication starts or gets terminated the following information is provided:


Method Summary
 ComConnection getCausingConnection()
           The connection that caused the creation or termination of this connection.
 boolean isPhoneInitiated()
          Indicates whether the communication has been initiated or terminated by the device handling the communication or by an application using Basic Communication.
 

Method Detail

isPhoneInitiated

boolean isPhoneInitiated()
Indicates whether the communication has been initiated or terminated by the device handling the communication or by an application using Basic Communication.

It cannot be distinguished whether another application not using Basic Communication initiates or terminates a communication or a device does it. Both cases are treated as device initiated actions.

Returns:
True if communication has been initiated by a device.

getCausingConnection

ComConnection getCausingConnection()

The connection that caused the creation or termination of this connection. Generally this is the partner within the communication (the partner of the connection to the caller is the connection to the called party and vice versa). But it depends on the InitiationReason for created communications and TerminationReason for terminated communications.

The following table explains the relationship between InitiationReason and CausingConnection for initiated communications, i.e. object is of type InitiationCause:

InitiationReason Causing Connection
NORMAL
CONSULTATION
The partner connection .
May be null if the partener is not yet known.
DEFLECT
TRANSFER
SINGLE_STEP_TRANSFER
CALLFORWARD_*
Connection to the original called party which deflected/forwarded the call.
CONFERENCE Connection to the initiator of the conference.

The following table explains the relationship between TerminationReason and CausingConnection for terminated communications, i.e. object is of type TerminationCause:

TerminationReason Causing Connection
NORMAL
RESOURCE_UNAVAILABLE
ERROR
UNKNOWN
null.
DEFLECT
TRANSFER
SINGLE_STEP_TRANSFER
Connection to the party to which the call was deflected/forwarded.

Returns:
the causing-connection if available (null, if not available).

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