OpenScape
V3.2, Revision 044 20100322

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

All Superinterfaces:
Reason
All Known Implementing Classes:
InitiationReasonImpl

public interface InitiationReason
extends Reason

Reason a connection has been created for.

Each ComConnection gets a reason why it has been created. It is part of the InitiationCause and can be retrieved by the method getInitiationReason().
During the whole livetime of the ComConnection this initiation reason is never changed.

Note: Java 1.5 enum types are not used because Java 1.4 compatibility is a requirement.


Field Summary
static InitiationReason CALL_PICKUP
          New communication because of call pickup.
static InitiationReason CALLBACK
          New communication because system originates a call back.
static InitiationReason CALLFORWARD_BUSY
          Connection forwarded by device.
static InitiationReason CALLFORWARD_IMMEDIATE
          Connection forwarded by device.
static InitiationReason CALLFORWARD_NOANSWER
          Connection forwarded by device.
static InitiationReason CALLFORWARD_UNSPECIFIED
          Connection forwarded by device.
static InitiationReason CONFERENCE
          Party joined a conference.
static InitiationReason CONSULTATION
          Another party is consulted.
static InitiationReason DEFLECT
          Alerting connection forwarded to another party.
static InitiationReason NORMAL
          Communication between two parties established.
static InitiationReason PARTICIPATION
          New communication partner because of silent participation or active participation.
static InitiationReason SINGLE_STEP_TRANSFER
          Established connection forwarded to another party.
static InitiationReason TRANSFER
          New communication partner because of transfering a communication.
 
Method Summary
 boolean compareState(InitiationReason reason)
          Compares the given reason with this object.
 

Field Detail

NORMAL

static final InitiationReason NORMAL
Communication between two parties established.

A standard communication connecting two parties together is established. This might be either by using the method connect()or by the phone device itself.
Both parties get this initiation reason.


CONSULTATION

static final InitiationReason CONSULTATION
Another party is consulted.

During an established communication another party gets consulted. The ComConnection of the consulted party gets this initiation reason.
The consultation might either be invoked by the phone device or by the method consult().


DEFLECT

static final InitiationReason DEFLECT
Alerting connection forwarded to another party.

When a connection in state ALERTING is forwarded to another party the new created ComConnection (for this other party) gets this initiation reason.
The forwarding might either be invoked by the phone device or by the method deflect().


CONFERENCE

static final InitiationReason CONFERENCE
Party joined a conference.

All ComConnection for parties joining an already existing conference get this initiation reason.
This can be achieved by the phone device if parties are added to a conference which are not configured users. Then these ComConnection get this initiation reason.
Or it can be achieved by the method connect() if invoked to add further parties to an already existing communication or conference. Then the ComConnection of these added parties get this initiation reason.

Note:
Because a ComConnection never changes its initiation reason this results in that not all parties of a conference have the initiation reason CONFERENCE. The first ones who created the communication will stay with their initiation reason (e.g. NORMAL). Or if the conference evolved from a consultation the initiation reason CONSULTATION will stay for the appropriate connections.


SINGLE_STEP_TRANSFER

static final InitiationReason SINGLE_STEP_TRANSFER
Established connection forwarded to another party.

When a connection in state CONNECTED is forwarded to another party the new created ComConnection (for this other party) gets this initiation reason.
The forwarding might either be invoked by the phone device or by the method transfer().


TRANSFER

static final InitiationReason TRANSFER
New communication partner because of transfering a communication.

When a communication is transfered from a consultation, either by the phone device or be the method transfer(), the new created ComConnection for each party gets this initiation cause.


CALLFORWARD_NOANSWER

static final InitiationReason CALLFORWARD_NOANSWER
Connection forwarded by device.

This initiation state is used when a communication is forwarded by the device or communication system because the call hasn't been answered.


CALLFORWARD_IMMEDIATE

static final InitiationReason CALLFORWARD_IMMEDIATE
Connection forwarded by device.

This initiation state is used when a communication is immediatelly forwarded by the device or communication system.


CALLFORWARD_BUSY

static final InitiationReason CALLFORWARD_BUSY
Connection forwarded by device.

This initiation state is used when a communication is forwarded by the device or communication system because the called device is busy.


CALLFORWARD_UNSPECIFIED

static final InitiationReason CALLFORWARD_UNSPECIFIED
Connection forwarded by device.

This initiation state is used when a communication is forwarded by the device or communication system for unknown reason.


CALL_PICKUP

static final InitiationReason CALL_PICKUP
New communication because of call pickup.

A call is picked up by the device. The concerned ComConnection gets this initiation reason.


PARTICIPATION

static final InitiationReason PARTICIPATION
New communication partner because of silent participation or active participation.

A call participant that has joined the call for silent participation or active participation. The concerned ComConnection gets this initiation reason.


CALLBACK

static final InitiationReason CALLBACK
New communication because system originates a call back.

This initiation state is used for a new communication because of a previously set call back feature.

Method Detail

compareState

boolean compareState(InitiationReason reason)
Compares the given reason with this object.

Implementation for type safe comparison.

Parameters:
reason - the reason to be compared.
Returns:
true, if the reasons are equal, otherwise false.

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