ch.ecma.csta.binding
Class ConsultationCall

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

All Implemented Interfaces:

java.io.Serializable

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

Places an existing active call at a device on hold and initiates a new call from the same device. The existing active call may include two or more devices.

The ConsultationCall request has these parameters:

ConsultationCall Request Parameters
existingCall	Mandatory	Existing Connection.
consultedDevice	Mandatory	Valid on-PBX extension or off PBX number.

CSTA Functional Requirements:

1. For the consultedDevice, all active features for this device will be honoured while the call is being made to it.
2. Not applicable as it pertains to consultOptions parameter which is not supported.
3. Not applicable as it pertains to consultOptions parameter which is not supported.
4. Not applicable as it pertains to consultOptions parameter which is not supported.
5. Not applicable as it pertains to consultOptions parameter which is not supported.
6. Not supported as it applies to partial dialling.
7. Not Supported.
8. Not supported as it applies to digital data call.
9. Not supported as it applies to digital data call.

Negative Acknowledgements:

• stateIncompatibility:invalidCallingDeviceState - Sent if the originator does not go off-hook within five seconds after originating the call and cannot be forced off-hook
• operation:invalidConnectionID - Sent if an invalid Connection ID was specified.
• operation:invalidDeviceID - Sent if an invalid Device ID was specified for existing call.
• operation:parameterTypeNotSupported - Sent if DynamicID is specified for existing call.
• stateIncompatibility:noActiveCall - Sent if the party to be put on hold is not currently active.
• subscribedResourceUnavailability:outstandingReqLimitExceeded - Sent if the client attempted to put a third party (two parties are on hold already) on hold on an analog station.
• 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

ConsultationCall()

Method Summary

boolean	equals(java.lang.Object obj) Note: hashCode() has not been overriden
byte[]	getAccountCode() Returns the value of field 'accountCode'.
byte[]	getAuthCode() Returns the value of field 'authCode'.
CallCharacteristics	getCallCharacteristics() Returns the value of field 'callCharacteristics'.
ConnectionInformation	getCallingConnectionInfo() Returns the value of field 'callingConnectionInfo'.
java.lang.Boolean	getConnectionReservation() Returns the value of field 'connectionReservation'.
DeviceID	getConsultedDevice() Returns the value of field 'consultedDevice'.
ConsultOptions	getConsultOptions() Returns the value of field 'consultOptions'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
ConnectionID	getExistingCall() Returns the value of field 'existingCall'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
MediaCallCharacteristics	getMediaCallCharacteristics() Returns the value of field 'mediaCallCharacteristics'.
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	setAuthCode(byte[] authCode) Sets the value of field 'authCode'.
void	setCallCharacteristics(CallCharacteristics callCharacteristics) Sets the value of field 'callCharacteristics'.
void	setCallingConnectionInfo(ConnectionInformation callingConnectionInfo) Sets the value of field 'callingConnectionInfo'.
void	setConnectionReservation(java.lang.Boolean connectionReservation) Sets the value of field 'connectionReservation'.
void	setConsultedDevice(DeviceID consultedDevice) Sets the value of field 'consultedDevice'.
void	setConsultOptions(ConsultOptions consultOptions) Sets the value of field 'consultOptions'.
void	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExistingCall(ConnectionID existingCall) Sets the value of field 'existingCall'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics) Sets the value of field 'mediaCallCharacteristics'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static ConsultationCall	unmarshalConsultationCall(java.io.Reader reader) Method unmarshalConsultationCall
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

ConsultationCall

public ConsultationCall()

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

getAuthCode

public byte[] getAuthCode()

Returns the value of field 'authCode'.

Returns:

byte

getCallCharacteristics

public CallCharacteristics getCallCharacteristics()

Returns the value of field 'callCharacteristics'.

Returns:

CallCharacteristics

getCallingConnectionInfo

public ConnectionInformation getCallingConnectionInfo()

Returns the value of field 'callingConnectionInfo'. The field 'callingConnectionInfo' has the following description: Specifies the connection information needed for the creation of the new connection at the consulting device. Optional. If this parameter is not present then the connection information is switching function specific.

Returns:

ConnectionInformation

getConnectionReservation

public java.lang.Boolean getConnectionReservation()

Returns the value of field 'connectionReservation'. The field 'connectionReservation' has the following description: Specifies that the media stream channel(s) associated with the call being placed on hold be reserved for reuse at a later time. Optional.

The complete set of possible values is:

• True - channel(s) is to be reserved.
• False - channel(s) is not to be reserved (default).

Returns:

Boolean

getConsultOptions

public ConsultOptions getConsultOptions()

Returns the value of field 'consultOptions'.

Returns:

ConsultOptions

getConsultedDevice

public DeviceID getConsultedDevice()

Returns the value of field 'consultedDevice'. The field 'consultedDevice' has the following description: Specifies the device to be consulted. Mandatory.

Returns:

DeviceID

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

getExistingCall

public ConnectionID getExistingCall()

Returns the value of field 'existingCall'. The field 'existingCall' has the following description: Specifies the active connection. Mandatory.

Returns:

ConnectionID

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

getMediaCallCharacteristics

public MediaCallCharacteristics getMediaCallCharacteristics()

Returns the value of field 'mediaCallCharacteristics'.

Returns:

MediaCallCharacteristics

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

setAuthCode

public void setAuthCode(byte[] authCode)

Sets the value of field 'authCode'.

Parameters:

authCode - the value of field 'authCode'.

setCallCharacteristics

public void setCallCharacteristics(CallCharacteristics callCharacteristics)

Sets the value of field 'callCharacteristics'.

Parameters:

callCharacteristics - the value of field 'callCharacteristics'.

setCallingConnectionInfo

public void setCallingConnectionInfo(ConnectionInformation callingConnectionInfo)

Sets the value of field 'callingConnectionInfo'. The field 'callingConnectionInfo' has the following description: Specifies the connection information needed for the creation of the new connection at the consulting device. Optional. If this parameter is not present then the connection information is switching function specific.

Parameters:

callingConnectionInfo - the value of field 'callingConnectionInfo'.

setConnectionReservation

public void setConnectionReservation(java.lang.Boolean connectionReservation)

Sets the value of field 'connectionReservation'. The field 'connectionReservation' has the following description: Specifies that the media stream channel(s) associated with the call being placed on hold be reserved for reuse at a later time. Optional.

The complete set of possible values is:

• True - channel(s) is to be reserved.
• False - channel(s) is not to be reserved (default).

Parameters:

connectionReservation - the value of field 'connectionReservation'.

setConsultOptions

public void setConsultOptions(ConsultOptions consultOptions)

Sets the value of field 'consultOptions'.

Parameters:

consultOptions - the value of field 'consultOptions'.

setConsultedDevice

public void setConsultedDevice(DeviceID consultedDevice)

Sets the value of field 'consultedDevice'. The field 'consultedDevice' has the following description: Specifies the device to be consulted. Mandatory.

Parameters:

consultedDevice - the value of field 'consultedDevice'.

setCorrelatorData

public void setCorrelatorData(CorrelatorData correlatorData)

Sets the value of field 'correlatorData'.

Parameters:

correlatorData - the value of field 'correlatorData'.

setExistingCall

public void setExistingCall(ConnectionID existingCall)

Sets the value of field 'existingCall'. The field 'existingCall' has the following description: Specifies the active connection. Mandatory.

Parameters:

existingCall - the value of field 'existingCall'.

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

setMediaCallCharacteristics

public void setMediaCallCharacteristics(MediaCallCharacteristics mediaCallCharacteristics)

Sets the value of field 'mediaCallCharacteristics'.

Parameters:

mediaCallCharacteristics - the value of field 'mediaCallCharacteristics'.

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

unmarshalConsultationCall

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

Method unmarshalConsultationCall

Parameters:

reader -

Returns:

ConsultationCall

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