ch.ecma.csta.binding
Class SingleStepTransferCall

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

All Implemented Interfaces:

java.io.Serializable

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

Transfers an existing connection at a device to another device. This transfer is performed in a single-step, that is the device doing the transfer does not have to place the existing call on hold before issuing the Single Step Transfer Call service.

For this product, the transferring connection must be in the Connected state. The alerting, failed, held and queued states are not supported.

The SingleStepTransferCall request has these parameters:

SingleStepTransferCall Request Parameters
activeCall	Mandatory	Active Connection.
transferredTo	Mandatory	Specifies the new called device.

CSTA Functional Requirements:

1. [AVAYA QUALIFIED] This product does not reuse callIDs in the activeCall or transferredCall parameters.
2. As a result of this service, the device or devices being transferred may hear call-progress signals for the new device. For example, if the new device answers, the call resumes or if the new device is busy or does not answer, the other devices in the call may receive resulting call progress tones. In either case, the transferring device has left the call and has no further relationship with it.
3. [AVAYA QUALIFIED] This product does not return the call to the transferring device if the Single Step Transfer Call service fails for any reason after the positive acknowledgement is returned.
4. For the new destination device (transferredTo device), all active features for the device are honoured.
5. Not supported as it applies to bridging.
6. 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 transferredTo parameter. A complete and valid device identifier will be provided, otherwise the switching function will reject the service request with a negative acknowledgement.
7. Not supported as it applies to digital data call.

Negative Acknowledgements:

• systemResourceAvailability:conferenceMemberLimitExceeded - Sent if the maximum number of parties are on the conference.
• stateIncompatibility:generic - Sent if both calls are alerting. Both calls are being service-observed. An active call is in a vector-processing stage.
• stateIncompatibility:invalidConnectionIDForActiveCall - Sent if the callID in activeCall or heldCall has not been specified correctly.
• operation:invalidConnectionID - Sent if the controlling deviceID in activeCall or heldCall has not been specified correctly.
• operation:invalidDeviceID - Sent if an invalid device ID is specified in heldCall or activeCall.
• stateIncompatibility:invalidConnectionState - Sent if the connections specified in the request are not in the valid states for the operation to take place. For example, it does not have one active call and one held call as required.
• operation:parameterTypeNotSupported - Sent if DynamicID is specified for activeCall or heldCall.
• 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

SingleStepTransferCall()

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'.
CorrelatorData	getCorrelatorData() Returns the value of field 'correlatorData'.
CSTACommonArguments	getExtensions() Returns the value of field 'extensions'.
java.lang.String	getLanguagePreferences() Returns the value of field 'languagePreferences'.
EventCause	getReason() Returns the value of field 'reason'.
java.lang.String	getSubjectOfCall() Returns the value of field 'subjectOfCall'.
DeviceID	getTransferredTo() Returns the value of field 'transferredTo'.
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	setCorrelatorData(CorrelatorData correlatorData) Sets the value of field 'correlatorData'.
void	setExtensions(CSTACommonArguments extensions) Sets the value of field 'extensions'.
void	setLanguagePreferences(java.lang.String languagePreferences) Sets the value of field 'languagePreferences'.
void	setReason(EventCause reason) Sets the value of field 'reason'.
void	setSubjectOfCall(java.lang.String subjectOfCall) Sets the value of field 'subjectOfCall'.
void	setTransferredTo(DeviceID transferredTo) Sets the value of field 'transferredTo'.
void	setUserData(UserData userData) Sets the value of field 'userData'.
static SingleStepTransferCall	unmarshalSingleStepTransferCall(java.io.Reader reader) Method unmarshalSingleStepTransferCall
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

SingleStepTransferCall

public SingleStepTransferCall()

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 the connection in the call to be replaced. Mandatory.

Returns:

ConnectionID

getAuthCode

public byte[] getAuthCode()

Returns the value of field 'authCode'.

Returns:

byte

getCorrelatorData

public CorrelatorData getCorrelatorData()

Returns the value of field 'correlatorData'.

Returns:

CorrelatorData

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

getReason

public EventCause getReason()

Returns the value of field 'reason'.

Returns:

EventCause

getSubjectOfCall

public java.lang.String getSubjectOfCall()

Returns the value of field 'subjectOfCall'.

Returns:

String

getTransferredTo

public DeviceID getTransferredTo()

Returns the value of field 'transferredTo'. The field 'transferredTo' has the following description: Specifies the new called (transferredTo) device. Mandatory.

Returns:

DeviceID

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 the connection in the call to be replaced. 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'.

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

setLanguagePreferences

public void setLanguagePreferences(java.lang.String languagePreferences)

Sets the value of field 'languagePreferences'.

Parameters:

languagePreferences - the value of field 'languagePreferences'.

setReason

public void setReason(EventCause reason)

Sets the value of field 'reason'.

Parameters:

reason - the value of field 'reason'.

setSubjectOfCall

public void setSubjectOfCall(java.lang.String subjectOfCall)

Sets the value of field 'subjectOfCall'.

Parameters:

subjectOfCall - the value of field 'subjectOfCall'.

setTransferredTo

public void setTransferredTo(DeviceID transferredTo)

Sets the value of field 'transferredTo'. The field 'transferredTo' has the following description: Specifies the new called (transferredTo) device. Mandatory.

Parameters:

transferredTo - the value of field 'transferredTo'.

setUserData

public void setUserData(UserData userData)

Sets the value of field 'userData'.

Parameters:

userData - the value of field 'userData'.

unmarshalSingleStepTransferCall

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

Method unmarshalSingleStepTransferCall

Parameters:

reader -

Returns:

SingleStepTransferCall

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