ch.ecma.csta.binding
Class ClearCall

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

All Implemented Interfaces:

java.io.Serializable

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

Releases all of the devices associated with the specified call. In the case of a conference call, this results in all devices in the conference call being released from the call.

The ClearCall request has these parameters:

ClearCall Request Parameters
callToBeCleared	Mandatory	Specifies the connection to be cleared.

CSTA Functional Requirements:

1. The Clear Call service will only affect the callToBeCleared ConnectionID's call. Other calls that exist at the callToBeCleared ConnectionID's device remain unaffected.
2. The connection ID provided in the request may consist of only a callID portion. This is an exception to the rule of not providing deviceIDs in connectionIDs of service requests (See ECMA-269, Section 6.1.5, "Connection").

Negative Acknowledgements:

• stateIncompatibility:noActiveCall - Sent if the ConnectionID specified in the request is not valid.
• 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

ClearCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
ConnectionID	getCallToBeCleared() Returns the value of field 'callToBeCleared'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
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	setCallToBeCleared(ConnectionID callToBeCleared) Sets the value of field 'callToBeCleared'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static ClearCall	unmarshalClearCall(java.io.Reader reader) Method unmarshalClearCall
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

ClearCall

public ClearCall()

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

getCallToBeCleared

public ConnectionID getCallToBeCleared()

Returns the value of field 'callToBeCleared'. The field 'callToBeCleared' has the following description: Specifies the connection to be cleared. Mandatory. The deviceID in the callToBeCleared ConnectionID may be omitted for this service.

Returns:

ConnectionID

getExtensions

public CSTACommonArguments getExtensions()

Returns the value of field 'extensions'.

Returns:

CSTACommonArguments

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

setCallToBeCleared

public void setCallToBeCleared(ConnectionID callToBeCleared)

Sets the value of field 'callToBeCleared'. The field 'callToBeCleared' has the following description: Specifies the connection to be cleared. Mandatory. The deviceID in the callToBeCleared ConnectionID may be omitted for this service.

Parameters:

callToBeCleared - the value of field 'callToBeCleared'.

setExtensions

public void setExtensions(CSTACommonArguments extensions)

Sets the value of field 'extensions'.

Parameters:

extensions - the value of field 'extensions'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalClearCall

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

Method unmarshalClearCall

Parameters:

reader -

Returns:

ClearCall

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