OpenScape
V3.2, Revision 044 20100322

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

All Superinterfaces:
Communication
All Known Subinterfaces:
VoiceCommunicationInternal
All Known Implementing Classes:
AbstractVoiceCommunication, VoiceCommunicationImpl, VoiceCommunicationImpl

public interface VoiceCommunication
extends Communication

Communication of media type voice.

Specific characteristic of a Communication object which describes a communication of media type voice. Objects of this class are to be instantiated by means of the method createVoiceCommunication().
Contains all methods with are not generic to all communications but specific to voice media.


Method Summary
 boolean canConference()
          Determine whether a conference is possible.
 boolean canConnect()
          Determine wether another party can be joined into this communication.
 boolean canConsult()
          Determine whether a consultation is possible.
 boolean canTransfer()
          Determine whether a transfer is possible.
 VoiceCommunicationAttribute getAttribute()
          Get current attributes object.
 VoiceConnection transfer(VoiceCommunication absorbedCommunication)
          Transfers a communication to the participants of a consultation.
 
Methods inherited from interface com.siemens.symphonia.bcom.bcommon.external.Communication
clearPreferredDevice, conference, connect, connect, consult, consult, getActiveConnectionNumber, getAttachedData, getComConnections, getComSession, getConnectionNumber, getKeysOfAttachedData, getMyConnection, getObjectId, removeAttachedData, setAttachedData, setPreferredDevice, setPreferredDevice
 

Method Detail

canConference

boolean canConference()
Determine whether a conference is possible.

Allows to check whether an invocation of the method conference(Communication) is possible in the current state of the communication. This might change with every state change of the communication.

Returns:
true iff invocation is possible.

canConnect

boolean canConnect()
Determine wether another party can be joined into this communication.

Allows to check whether an invocation of the methods connect(ComEndpoint) or connect(String) is possible in the current state of the communication. This might change with every state change of the communication.

Returns:
true iff invocation is possible.

canConsult

boolean canConsult()
Determine whether a consultation is possible.

Allows to check whether an invocation of the methods consult(ComConnection, ComEndpoint) or consult(ComConnection, String) is possible in the current state of the communication. This might change with every state change of the communication.

Returns:
true iff invocation is possible.

canTransfer

boolean canTransfer()
Determine whether a transfer is possible.

Allows to check whether an invocation of the method transfer(VoiceCommunication) is possible in the current state of the communication. This might change with every state change of the communication.

Returns:
true iff invocation is possible.

transfer

VoiceConnection transfer(VoiceCommunication absorbedCommunication)
Transfers a communication to the participants of a consultation.

In an existing consultation communication the two parties in consultation can be brought together in one single communication. The originator of the consultation leaves the communication at the same point of time.

This VoiceCommunication object persists and hosts the emerging communication from the consultation communication. The other VoiceCommunication object (as passed by the parameter absorbedCommunication) gets terminated after the ComConnection of the consultation partner has been moved to this Communication.

Note:
This method invokes a synchronous service request which implicates:

Parameters:
absorbedCommunication - the consultation communication which is added to this one
Returns:
the active ComConnection of this user.
Throws:
ComException - on immediate detected problems.

getAttribute

VoiceCommunicationAttribute getAttribute()
Get current attributes object.

Get the attribute object of this VoiceCommunication object. This allows to read and (where appropriate) to write the different attributes.

Returns:
the attributes object.

OpenScape
V3.2, Revision 044 20100322

Copyright (c) 2014 Unify, Germany
All rights reserved.

This software is the confidential and proprietary information of Unify, Germany