ch.ecma.csta.binding
Class ClearConnection

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

All Implemented Interfaces:

java.io.Serializable

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

Releases a specific device from a call. In the case of a two-party call, this may result in the call being torn down. In the case of a conference call, this results in the specific party being removed from the conference. This service can also be used to inactivate a bridged appearance.

The Connection ID provided in the request is released.

The ClearConnection request has these parameters:

ClearConnection Request Parameters
connectionToBeCleared	Mandatory	A valid connection ID that indicates the callID and station extension.

CSTA Functional Requirements:

1. If the call associated with Clear Connection service has multiple devices that are outside the switching subdomain, they may remain connected after this service is complete.
2. Not supported as it applies to bridging.
3. The switching function should only accept the ClearCall service request and not the Clear Connection service request if clearing a connection that is involved in a conference call causes the entire conference call to be terminated. However, some switching functions accept a Clear Connection service when it results in an entire conference call to be terminated. The capability exchange services indicate if the switching functions protects or allows a conference call from being torn down via the Clear Connection service.
4. Not Supported

Negative Acknowledgements:

• stateIncompatibility:invalidConnectionState - Sent if the specified connection is not in a valid state for this operation.
• stateIncompatibility:noActiveCall - Sent if invalid connection ID specified. CallID may be invalid.
• stateIncompatibility:noConnectionToClear - Sent if the connection ID contained in the request is invalid. CallID may be incorrect.
• systemResourceAvailability:resourceBusy - Sent if the switch is busy with another CSTA request.
• operation:securityViolation - Sent if the user was not authorized to control the specified device.
• 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

ClearConnection()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getConnectionToBeCleared() Returns the value of field 'connectionToBeCleared'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
EventCause	getReason() Returns the value of field 'reason'.
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	setConnectionToBeCleared(ConnectionID connectionToBeCleared) Sets the value of field 'connectionToBeCleared'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setReason(EventCause reason) Sets the value of field 'reason'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static ClearConnection	unmarshalClearConnection(java.io.Reader reader) Method unmarshalClearConnection
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

ClearConnection

public ClearConnection()

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

getConnectionToBeCleared

public ConnectionID getConnectionToBeCleared()

Returns the value of field 'connectionToBeCleared'. The field 'connectionToBeCleared' has the following description: Specifies the connection to be cleared. Mandatory.

Returns:

ConnectionID

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

getReason

public EventCause getReason()

Returns the value of field 'reason'.

Returns:

EventCause

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

setConnectionToBeCleared

public void setConnectionToBeCleared(ConnectionID connectionToBeCleared)

Sets the value of field 'connectionToBeCleared'. The field 'connectionToBeCleared' has the following description: Specifies the connection to be cleared. Mandatory.

Parameters:

connectionToBeCleared - the value of field 'connectionToBeCleared'.

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

setReason

public void setReason(EventCause reason)

Sets the value of field 'reason'.

Parameters:

reason - the value of field 'reason'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalClearConnection

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

Method unmarshalClearConnection

Parameters:

reader -

Returns:

ClearConnection

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