ch.ecma.csta.binding
Class JoinCall

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Allows a computing function to request, on behalf of a device, that the device be joined into an existing call. In the process of establishing a connection with the joiningDevice, the joiningDevice may be prompted to go off-hook (if necessary) and when that device does so, it is added into the call.

This service is different from the SingleStepConferenceCall service in that the request is made on behalf of the joiningDevice (originating device).

This service is different from the IntrudeCall service in that there is no prior failed call at the intruded-upon connection.

For an illustration of this event, see ECMA 269, section 17.1.17, Figure 17-19 "Join Call Service".

Connection State Transitions:

• The conferencedCall) connection will transition from an allowable initial state of Null to an allowable final state of Connected.
• All other connections are unaffected (that is, there is no transition due to this service).

See ECMA 269, section 17.1.17.3.2, for the following table describing the sequence of events for device-type monitoring. Table 17-93 "Join Call - Device-Type Monitoring Event Sequences"

See ECMA 269, section 17.1.17.3.3, for the following tables describing the sequence of events for call-type monitoring. Table 17-94 "Join Call - Call-Type Monitoring Event Sequences"

CSTA Functional Requirements:

1. The appearances in a shared bridged device configuration are unaffected by this service.
2. 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 (that is, the ";" character) in it for the joiningDevice parameter. A complete and valid device identifier will be provided, otherwise the switching function will reject the service request with a negative acknowledgement.
3. Prompting of the joining device during the processing of the Join Call service is switching function specific (display flashing, ring pattern, lamp blinking, etc.).
4. If the autoOriginate parameter has a value of "Do Not Prompt", then the device should be a speakerphone, hands-free telephone, or other device that can be automatically answered. If the device is not of this type, then the processing of this parameter is switching function specific. For example, the switching function may choose to accept this service and ignore this parameter, or it may reject the Join Call service with negative acknowledgement.
5. Call Forwarding and Do Not Disturb features for the joining device are not honoured. If a switching function supports prompting of the joining device and detects that a feature was activated while processing the Join Call service and this feature cannot be overridden, then the switching function will return a negative acknowledgement.
6. The call ID in the ConnectionIDs for the resulting conference call is inherited from the original active call.
7. When prompting a device which has a call appearance, bridged, or hybrid device configuration, only one of the appearances will be delivered the call.
8. If this service is used to join a device into a digital data call, the connection for the joiningDevice (that is, conferencedCall) will inherit the characteristics of the call with the exception of connection flow direction and the number of channels used. In these cases, the connection flow direction is dependent on the value of participationType and the number of channels is based on what the switching function will use to allow the joiningDevice to effectively participate in the call.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

JoinCall()

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'.
AutoOriginate	getAutoOriginate() Returns the value of field 'autoOriginate'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
DeviceID	getJoiningDevice() Returns the value of field 'joiningDevice'.
ParticipationType	getParticipationType() Returns the value of field 'participationType'.
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	setAutoOriginate(AutoOriginate autoOriginate) Sets the value of field 'autoOriginate'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setJoiningDevice(DeviceID joiningDevice) Sets the value of field 'joiningDevice'.
void	setParticipationType(ParticipationType participationType) Sets the value of field 'participationType'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static JoinCall	unmarshalJoinCall(java.io.Reader reader) Method unmarshalJoinCall
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

JoinCall

public JoinCall()

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 an active call to which the new device is to be added (or joined). Mandatory.

Returns:

ConnectionID

getAuthCode

public byte[] getAuthCode()

Returns the value of field 'authCode'.

Returns:

byte

getAutoOriginate

public AutoOriginate getAutoOriginate()

Returns the value of field 'autoOriginate'. The field 'autoOriginate' has the following description: Specifies if the joining device is to be prompted or not (handsfree mode). Optional.

The complete set of possible values is:

• Prompt (default)
• Do Not Prompt (auto originate)

Returns:

AutoOriginate

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getJoiningDevice

public DeviceID getJoiningDevice()

Returns the value of field 'joiningDevice'. The field 'joiningDevice' has the following description: Specifies the device that is to be added to (join) the existing call. Mandatory.

Returns:

DeviceID

getParticipationType

public ParticipationType getParticipationType()

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

This is one of the following:

• active (default) - the joining device actively participates in the resulting conference call. As a result, the flow direction of the joiningDevice's connection (that is, conferencedCall) will be Transmit and Receive.
• silent - the joining device can listen but cannot actively participate in the resulting conference call. As a result, the flow direction of the joiningDevice's connection (that is, conferencedCall) will be Receive.
• none - the joining device cannot actively participate in the resulting conference call. As a result, the flow direction of the joiningDevice's connection (that is, conferencedCall) will be None.

Returns:

ParticipationType

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 an active call to which the new device is to be added (or joined). 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'.

setAutoOriginate

public void setAutoOriginate(AutoOriginate autoOriginate)

Sets the value of field 'autoOriginate'. The field 'autoOriginate' has the following description: Specifies if the joining device is to be prompted or not (handsfree mode). Optional.

The complete set of possible values is:

• Prompt (default)
• Do Not Prompt (auto originate)

Parameters:

autoOriginate - the value of field 'autoOriginate'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setJoiningDevice

public void setJoiningDevice(DeviceID joiningDevice)

Sets the value of field 'joiningDevice'. The field 'joiningDevice' has the following description: Specifies the device that is to be added to (join) the existing call. Mandatory.

Parameters:

joiningDevice - the value of field 'joiningDevice'.

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 joining device has in the resulting call. Optional.

This is one of the following:

• active (default) - the joining device actively participates in the resulting conference call. As a result, the flow direction of the joiningDevice's connection (that is, conferencedCall) will be Transmit and Receive.
• silent - the joining device can listen but cannot actively participate in the resulting conference call. As a result, the flow direction of the joiningDevice's connection (that is, conferencedCall) will be Receive.
• none - the joining device cannot actively participate in the resulting conference call. As a result, the flow direction of the joiningDevice's connection (that is, conferencedCall) will be None.

Parameters:

participationType - the value of field 'participationType'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalJoinCall

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

Method unmarshalJoinCall

Parameters:

reader -

Returns:

JoinCall

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