ch.ecma.csta.binding
Class SingleStepConferenceCall

java.lang.Object
  ch.ecma.csta.CastorObject
      ch.ecma.csta.binding.SingleStepConferenceCall

All Implemented Interfaces:

java.io.Serializable

public class SingleStepConferenceCall
extends ch.ecma.csta.CastorObject
implements java.io.Serializable

Adds a device to an existing call.

Note that the party that is added is not alerted in any way: their telephone is forced off-hook. As a result, this operation should generally be used to add an application controlled device to the call, rather than to add actual parties to the conference.

The SingleStepConferenceCall request has these parameters:

SingleStepConferenceCall Parameters
activeCall	Mandatory	Unique identifier of the call to which the party is to be added. Should be discovered using SnapshotDevice
deviceToJoin	Mandatory	Unique identifier of the device / extension to be joined to the call. Note that this party will NOT be alerted.
Participation Type	Optional	Indicates whether the added device can talk (Active) or not (Silent).

CSTA Functional Requirements:

1. The call ID in the ConnectionIDs for the resulting conference call is the same as that in the original active call.
2. It is switching function dependent to determine at which point in the call progress a device is actually conferenced into a call. For example, a device may become part of an existing call before it is actually conferenced into a call. In this case, additional events may flow before the Conferenced event. The callID in the ConnectionIDs for these events shall be the same as that in the original active call and shall be the same as in the Conferenced event that follows.
3. Not applicable as it applies to bridging.
4. This service request does not support the use of a null device identifier or a Diallable Digits format (DD) device identifier that has a partial dialling sequence character (i.e., the ';' character) in it for the deviceToJoin parameter. A complete and valid device identifier shall be provided, otherwise the switching function will reject the service request with a negative acknowledgement.
5. For the new destination device (deviceToJoin), all active features for the device are honoured.
6. Not supported as it applies to digital data call.

Negative Acknowledgements:

• operation:invalidDeviceID - Sent if the specified DeviceID is not valid. The device must be registered for the call to succeed.
• operation:invalidConnectionID - Sent if the specified ConnectionID is not valid. The call may have ended.
• systemResourceAvailability:conferenceMemberLimitExceeded - Sent if the request would have increased the number of parties on the call beyond the maximum number of conference parties (currently 6).
• systemResourceAvailability:resourceBusy - Sent if the deviceToJoin is already active on a call. The deviceToJoin must be idle for the request to succeed.
• stateIncompatibility:invalidCallingDeviceState - Sent if the deviceToJoin is not registered.
• stateIncompatibility:invalidDestinationDeviceState - Sent if the deviceToJoin could not be forced off-hook (e.g. because it's an analog station) and it could not be forced off-hook within 5 seconds.
• operation:invalidParticipationType - Sent if the participation type of "NONE" is requested.
• operation:generic - Sent if a logic error occurred in the code.
• unspecified - Sent if an implementation specific error occurred.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

SingleStepConferenceCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
byte[]	getAccountCode() Returns the value of field 'accountCode'.
ConnectionID	getActiveCall() Returns the value of field 'activeCall'.
byte[]	getAuthCode() Returns the value of field 'authCode'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
DeviceID	getDeviceToJoin() Returns the value of field 'deviceToJoin'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
ParticipationType	getParticipationType() Returns the value of field 'participationType'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
UserData	getUserData() Returns the value of field 'userData'.
boolean	isValid() Method isValid
void	marshal(org.xml.sax.ContentHandler handler) Method marshal
void	marshal(java.io.Writer out) Method marshal
void	setAccountCode(byte[] accountCode) Sets the value of field 'accountCode'.
void	setActiveCall(ConnectionID activeCall) Sets the value of field 'activeCall'.
void	setAuthCode(byte[] authCode) Sets the value of field 'authCode'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setDeviceToJoin(DeviceID deviceToJoin) Sets the value of field 'deviceToJoin'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setParticipationType(ParticipationType participationType) Sets the value of field 'participationType'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static SingleStepConferenceCall	unmarshalSingleStepConferenceCall(java.io.Reader reader) Method unmarshalSingleStepConferenceCall
void	validate() Method validate

Methods inherited from class ch.ecma.csta.CastorObject

getOldSessionID, hashCode, setOldSessionID, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SingleStepConferenceCall

public SingleStepConferenceCall()

Method Detail

equals

public boolean equals(java.lang.Object obj)

Note: hashCode() has not been overriden

Overrides:

equals in class ch.ecma.csta.CastorObject

Parameters:

obj -

Returns:

boolean

getAccountCode

public byte[] getAccountCode()

Returns the value of field 'accountCode'.

Returns:

byte

getActiveCall

public ConnectionID getActiveCall()

Returns the value of field 'activeCall'. The field 'activeCall' has the following description: Specifies an existing connection in the call to which a new device is to be added. Mandatory.

Returns:

ConnectionID

getAuthCode

public byte[] getAuthCode()

Returns the value of field 'authCode'.

Returns:

byte

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getDeviceToJoin

public DeviceID getDeviceToJoin()

Returns the value of field 'deviceToJoin'. The field 'deviceToJoin' has the following description: Specifies the device that is to be added to the call. Mandatory.

Returns:

DeviceID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getLanguagePreferences

public java.lang.String getLanguagePreferences()

Returns the value of field 'languagePreferences'.

Returns:

String

getParticipationType

public ParticipationType getParticipationType()

Returns the value of field 'participationType'. The field 'participationType' has the following description: Specifies the type of participation the added device has in the resulting call. Optional.

The complete set of possible values is:

• Active (default) - The added device actively participates in the resulting conference call. As a result, the flow direction of the deviceToJoin's connection (that is, conferencedCall) will be Transmit and Receive.
• Silent - The added device can listen but cannot actively participate in the resulting conference call. As a result, the flow direction of the deviceToJoin's connection (that is, conferencedCall) will be Receive.
• None - Not supported.

Returns:

ParticipationType

getSubjectOfCall

public java.lang.String getSubjectOfCall()

Returns the value of field 'subjectOfCall'.

Returns:

String

getUserData

public UserData getUserData()

Returns the value of field 'userData'.

Returns:

UserData

isValid

public boolean isValid()

Method isValid

Returns:

boolean

marshal

public void marshal(java.io.Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

out -

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException

Method marshal

Parameters:

handler -

Throws:

java.io.IOException

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

setAccountCode

public void setAccountCode(byte[] accountCode)

Sets the value of field 'accountCode'.

Parameters:

accountCode - the value of field 'accountCode'.

setActiveCall

public void setActiveCall(ConnectionID activeCall)

Sets the value of field 'activeCall'. The field 'activeCall' has the following description: Specifies an existing connection in the call to which a new device is to be added. Mandatory.

Parameters:

activeCall - the value of field 'activeCall'.

setAuthCode

public void setAuthCode(byte[] authCode)

Sets the value of field 'authCode'.

Parameters:

authCode - the value of field 'authCode'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setDeviceToJoin

public void setDeviceToJoin(DeviceID deviceToJoin)

Sets the value of field 'deviceToJoin'. The field 'deviceToJoin' has the following description: Specifies the device that is to be added to the call. Mandatory.

Parameters:

deviceToJoin - the value of field 'deviceToJoin'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setLanguagePreferences

public void setLanguagePreferences(java.lang.String languagePreferences)

Sets the value of field 'languagePreferences'.

Parameters:

languagePreferences - the value of field 'languagePreferences'.

setParticipationType

public void setParticipationType(ParticipationType participationType)

Sets the value of field 'participationType'. The field 'participationType' has the following description: Specifies the type of participation the added device has in the resulting call. Optional.

The complete set of possible values is:

• Active (default) - The added device actively participates in the resulting conference call. As a result, the flow direction of the deviceToJoin's connection (that is, conferencedCall) will be Transmit and Receive.
• Silent - The added device can listen but cannot actively participate in the resulting conference call. As a result, the flow direction of the deviceToJoin's connection (that is, conferencedCall) will be Receive.
• None - Not supported.

Parameters:

participationType - the value of field 'participationType'.

setSubjectOfCall

public void setSubjectOfCall(java.lang.String subjectOfCall)

Sets the value of field 'subjectOfCall'.

Parameters:

subjectOfCall - the value of field 'subjectOfCall'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalSingleStepConferenceCall

public static SingleStepConferenceCall unmarshalSingleStepConferenceCall(java.io.Reader reader)
                                                                  throws org.exolab.castor.xml.MarshalException,
                                                                         org.exolab.castor.xml.ValidationException

Method unmarshalSingleStepConferenceCall

Parameters:

reader -

Returns:

SingleStepConferenceCall

Throws:

org.exolab.castor.xml.MarshalException

org.exolab.castor.xml.ValidationException

validate

public void validate()
              throws org.exolab.castor.xml.ValidationException

Method validate

Throws:

org.exolab.castor.xml.ValidationException