ch.ecma.csta.binding
Class IntrudeCall

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

All Implemented Interfaces:

java.io.Serializable

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

This request is not supported.

Allows a computing function to add the calling device to a call at a busy called device.

The result will be that the calling device is either actively or silently participating in the called device's existing call or consulting with the called device with a new call.

There are two cases specified for the Intrude Call service:

• Case A: In this case, the calling device (D1) joins call C2 with devices D2 and D3.
• Case B: In this case, the called device (D2) places its existing active call on hold first and then connects to the new calling device (D1).

For an illustration of this event, see ECMA 269, section 17.1.16, Figure 17-17 "Intrude Call Service (Case A)" and Figure 17-18 "Intrude Call Service (Case B)".

See ECMA 269, section 17.1.16.3.1, for the following table describing the Connection State Transitions. Table 17-85 "Intrude Call - Connection State Transitions"

See ECMA 269, section 17.1.16.3.2, for the following tables describing the sequence of events for device-type monitoring. Table 17-86 "Intrude Call - Device-Type Monitoring Event Sequences (Case A)" Table 17-87 "Intrude Call - Device-Type Monitoring Event Sequences (Case B)"

See ECMA 269, section 17.1.8.3.3, for the following tables describing the sequence of events for call-type monitoring. Table 17-88 "Intrude Call - Call-Type Monitoring Event Sequences (Case A)" Table 17-89 "Intrude Call - Call-Type Monitoring Event Sequences (Case B)"

CSTA Functional Requirements:

1. To cancel an Intrude Call service, the computing function can either:
   • Issue the ClearConnection or ClearCall service with the ConnectionID of either the calling (cases A or B) or called (case B) device.
   • Have the calling device go on-hook.
   If the above is successfully executed, normal call progress messages of Connection Cleared (with an event cause of Normal Clearing) will be generated.
2. The computing function should never assume the reuse of callIDs, although some switching functions may reuse one or the other.
3. If the called device has more than one call during the execution of this service, the switching function will choose which call to intrude upon.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

IntrudeCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
ConnectionID	getIntrude() Returns the value of field 'intrude'.
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	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setIntrude(ConnectionID intrude) Sets the value of field 'intrude'.
void	setParticipationType(ParticipationType participationType) Sets the value of field 'participationType'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static IntrudeCall	unmarshalIntrudeCall(java.io.Reader reader) Method unmarshalIntrudeCall
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

IntrudeCall

public IntrudeCall()

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

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getIntrude

public ConnectionID getIntrude()

Returns the value of field 'intrude'. The field 'intrude' has the following description: Specifies the connection of the calling device. Mandatory.

Returns:

ConnectionID

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.
• silent - The added device can listen but cannot actively participate in the resulting conference call.
• none - The added device cannot actively participate in the resulting conference call. As a result, the flow direction of the added devices's connection will be None.

If the switching function only supports "Case B" of the service and the participationType parameter is supplied, then the service will be rejected by the switching function.

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

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setIntrude

public void setIntrude(ConnectionID intrude)

Sets the value of field 'intrude'. The field 'intrude' has the following description: Specifies the connection of the calling device. Mandatory.

Parameters:

intrude - the value of field 'intrude'.

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.
• silent - The added device can listen but cannot actively participate in the resulting conference call.
• none - The added device cannot actively participate in the resulting conference call. As a result, the flow direction of the added devices's connection will be None.

If the switching function only supports "Case B" of the service and the participationType parameter is supplied, then the service will be rejected by the switching function.

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'.

unmarshalIntrudeCall

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

Method unmarshalIntrudeCall

Parameters:

reader -

Returns:

IntrudeCall

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