|
OpenScape V3.2, Revision 044 20100322 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Communication
Generic representation of a communication.
A Communication
represents one communication for one media type. The specific features of the
actual media is represented by an extended object (e.g.
VoiceCommunication
for
the media type voice).
Therefore a Communication
cannot be instantiated but only the extended object for a
specific media type. For voice communication the method
createVoiceCommunication()
can be used.
Method Summary | |
---|---|
void |
clearPreferredDevice()
Cancel overwrite of preferred device. |
ComConnection |
conference(Communication absorbedCommunication)
Joins parties of a consultation communication together. |
ComConnection |
connect(ComEndpoint calledParty)
Add new party to communication. |
ComConnection |
connect(java.lang.String targetUri)
Add new party to communication. |
ComConnection |
consult(ComConnection consultingConnection,
ComEndpoint consultedEndpoint)
Make a consultation communication. |
ComConnection |
consult(ComConnection consultingConnection,
java.lang.String targetUri)
Make a consultation communication. |
int |
getActiveConnectionNumber()
Number of active ComConnections . |
java.io.Serializable |
getAttachedData(java.lang.String key)
Retrieves attached data. |
java.util.Iterator |
getComConnections()
Provides all connections of this communication. |
ComSession |
getComSession()
Get the ComSession this Communication belongs to. |
int |
getConnectionNumber()
Number of all ComConnections . |
java.lang.String[] |
getKeysOfAttachedData()
Get all keys used for attached data. |
ComConnection |
getMyConnection()
Get the own connection. |
java.lang.String |
getObjectId()
Get a string that can be used to identify this communication object. |
void |
removeAttachedData(java.lang.String key)
Removes attached data. |
void |
setAttachedData(java.lang.String key,
java.io.Serializable value)
Stores attached data. |
void |
setPreferredDevice(ComEndpoint preferredDevice)
Overwrite preferred device setting. |
void |
setPreferredDevice(java.lang.String targetUri)
Overwrite preferred device setting. |
Method Detail |
---|
ComSession getComSession()
ComSession
this Communication
belongs to.
A ComSession
can be used to group
Communications
together. The ComSession
this Communications
belongs to is retrieved by this method.
ComSession
this Communication
belongs to.java.util.Iterator getComConnections()
For each participant of the communication there is a
ComConnection
object describing the
state and allowing further operations. All ComConnections
of the communication are
retrieved independent from their state.
Iterator
to list of
ComConnection
objects.int getConnectionNumber()
ComConnections
.
Determine the total number of all
ComConnection
objects currently
associated with this communication independent of their state.
int getActiveConnectionNumber()
ComConnections
.
Determine the total number of all
ComConnection
objects currently
associated with this communication and their state is not
TERMINATED
.
ComConnection getMyConnection()
Relating to a user's view there is in any communication one (and only one)
ComConnection
which represents
the own connection.
An ordinary user is only allowed to carry methods out on this connection. The other connections
are only for information purpose. Ie. a user can see who are the other participants of the communication
and what they are doing but don't control them.
ComConnection connect(ComEndpoint calledParty)
Create new ComConnection
object(s)
for this Communication
. From the graph model this means just adding further
ComConnection
nodes. Applied it takes the following effects:
Communication
:
Communication
with the same own endpoint (e.g.
preferred device didn't change since establishment of last communication) a consultation is
invoked. I.e. the already existing communication is placed on hold and a new one is established.
Communication
but with a
different own endpoint this still results in a new communication.
Communication
,
a conference is started or a new party is added to the already existing conference.
ComEndpoint
object obtained from
Basic Communication maybe used as target for the communication. This holds also for ComEndpoint
objects received by events or walking through the graph.
Note:
This method invokes a synchronous service request which implicates:
calledParty
- endpoint new connection should be established to.
ComConnection
object.
ComException
- on immediate detected problems.ComConnection connect(java.lang.String targetUri)
Has the same semantics as
connect(ComEndpoint)
but allows to specify the communication target as URI. The following URI formats are supported:
getComEndpointsForNumber()
with lineout
parameter set to
MANUAL
.
targetUri
- URI new connection should be established to.
ComConnection
object.
ComException
- on immediate detected problems.ComConnection consult(ComConnection consultingConnection, ComEndpoint consultedEndpoint)
Places an existing communication on hold and creates a communication to another party. The following pre-conditions must hold:
ComConnection
in this Communication
object.
alternate()
or join all parties together using the method
conference()
.
Remark:
The methods
connect(ComEndpoint)
or
connect(String)
can achieve the same consultation communication. But these methode fail if it is not possible to establish
a consultation communication whereas connect()
establishes are second (independent) communication
or creates a conference.
Generally you create a new Communication
by means of
createVoiceCommunication()
and invoke this method on the new Communication
. As parameter consultingConnection
your own already established connection from another communication has to be provided.
Note:
This method invokes a synchronous service request which implicates:
consultingConnection
- the already existing connection of the user.consultedEndpoint
- endpoint new connection should be established to.
ComException
- on immediate detected problems.ComConnection consult(ComConnection consultingConnection, java.lang.String targetUri)
Has the same semantics as
consult(ComConnection, ComEndpoint)
but allows to specify the communication target as URI. The following URI formats are supported:
getComEndpointsForNumber()
with lineout
parameter set to
MANUAL
.
consultingConnection
- the already existing connection of the user.targetUri
- URI new connection should be established to.
ComException
- on immediate detected problems.ComConnection conference(Communication absorbedCommunication)
All parties of a consultation communication are joined together in one combined conference.
This Communication
object persists and hosts the emerging conference from the consultation
communication. The other Communication
object (as passed by the parameter
absorbedCommunication
) gets terminated after the ComConnection
of the
communication partner has been moved to this Communication
.
It is also possible to join a consultation communication to an already existing conference. Repeating
this multiple times results in a conference with more then three participants.
Note:
This method invokes a synchronous service request which implicates:
absorbedCommunication
- the consultation communication which is added to this one
ComConnection
of this user.
ComException
- on immediate detected problems.java.io.Serializable getAttachedData(java.lang.String key)
Gets the attached data object stored previous by
setAttachedData()
.
Note:
This method invokes a synchronous service request which implicates:
key
- which was used to store the data object.
null
if there are no attached data with the given
key.void setAttachedData(java.lang.String key, java.io.Serializable value)
Allows to store an application specific data object with this Communication
. The identification
of the data object is done by a key selected by the application.
There is no check for uniqueness of the given key. If the key is already used the old data object is overwritten by the new one.
The size of the data object to be stored is checked against a limit and also the sum of all data objects
stored with this Communication
is checked. It is not allowed to store more data than this limits.
Huge objects should be stored in the database and only the database reference should be attached.
The current limit for both checks is 10KByte.
Note:
This method invokes a synchronous service request which implicates:
key
- which is to be used for storing the data object.value
- object to be stored as attached data.void removeAttachedData(java.lang.String key)
Searches for the attached data specified by the given key and removes both the
data object and the key.
It is silently ignored if the given key doesn't exist.
Note:
This method invokes a synchronous service request which implicates:
key
- of the data object to be removed.java.lang.String[] getKeysOfAttachedData()
Retrieves all keys for which data are attached on this Communication
.
Note:
This method invokes a synchronous service request which implicates:
void setPreferredDevice(ComEndpoint preferredDevice)
Defines a preferred device which holds only for this Communication
. I.e. the methods
connect(ComEndpoint)
and
connect(String)
as well as
deflectONS()
and
transferONS()
invoked on a
VoiceConnection
object which is
part of this communication will use this preferred device instead of the database setting.
This setting is not persistent. When the Communication
is terminated also the overwrite expires.
Note:
This method invokes a synchronous service request which implicates:
preferredDevice
- target to overwrite database setting.void setPreferredDevice(java.lang.String targetUri)
Has the same semantics as
setPreferredDevice(ComEndpoint)
but allows to specify the preferred device as URI. The following URI
formats are supported:
targetUri
- URI the preferred device should be set to.void clearPreferredDevice()
Cancels a possibly overwrite of the preferred device as set by
setPreferredDevice(ComEndpoint)
or
setPreferredDevice(String)
. I.e. the database setting will be used again.
If no overwrite is set the method does nothing.
Note:
This method invokes a synchronous service request which implicates:
java.lang.String getObjectId()
|
OpenScape V3.2, Revision 044 20100322 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This software is the confidential and proprietary information of Unify, Germany