cisco.uc.cuae.legacy
Class CallControl.MakeCallResult

java.lang.Object
  cisco.uc.cuae.legacy.CallControl.MakeCallResult

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

CallControl

public static class CallControl.MakeCallResult
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Field Summary

java.lang.String	callId Unique identifier used to identify this call in all subsequent Call Control API operations.
java.lang.String	conferenceId Unique identifier for the conference that this connection was placed in.
java.lang.String	connectionId Unique identifier used to identify this connection in all subsequent Media Control API operations.
java.lang.String	endReason The condition which caused the call leg to fail to complete.
java.lang.String	from The calling number, or caller ID, for this call.
java.lang.String	mediaTxCodec The codec that the media engine connection should use when sending audio.
java.lang.Long	mediaTxFramesize The framesize that the media engine connection should use when sending audio.
java.lang.String	mediaTxIP The IP address that the media engine connection should send audio to.
java.lang.Long	mediaTxPort The port that the media engine connection should send audio to.
java.lang.Long	mmsId Unique identifier used to identify the media engine in control of this connection.
java.lang.String	originalTo The originally dialed number for this call.
CuaeCommon.CuaeResult	returnValue
java.lang.String	to The final called number for this call.

Constructor Summary

CallControl.MakeCallResult()
Constructs the MakeCallResult.

CallControl.MakeCallResult(CuaeCommon.CuaeResult returnValue, java.lang.String callId, java.lang.Long mmsId, java.lang.String to, java.lang.String from, java.lang.String originalTo, java.lang.String connectionId, java.lang.String conferenceId, java.lang.String mediaTxIP, java.lang.Long mediaTxPort, java.lang.String mediaTxCodec, java.lang.Long mediaTxFramesize, java.lang.String endReason)
Constructs the MakeCallResult.

Method Summary

java.lang.String	getCallId() Gets the value.
java.lang.String	getConferenceId() Gets the value.
java.lang.String	getConnectionId() Gets the value.
java.lang.String	getEndReason() Gets the value.
java.lang.String	getFrom() Gets the value.
java.lang.String	getMediaTxCodec() Gets the value.
java.lang.Long	getMediaTxFramesize() Gets the value.
java.lang.String	getMediaTxIP() Gets the value.
java.lang.Long	getMediaTxPort() Gets the value.
java.lang.Long	getMmsId() Gets the value.
java.lang.String	getOriginalTo() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
java.lang.String	getTo() Gets the value.
void	setCallId(java.lang.String value) Sets the value.
void	setConferenceId(java.lang.String value) Sets the value.
void	setConnectionId(java.lang.String value) Sets the value.
void	setEndReason(java.lang.String value) Sets the value.
void	setFrom(java.lang.String value) Sets the value.
void	setMediaTxCodec(java.lang.String value) Sets the value.
void	setMediaTxFramesize(java.lang.Long value) Sets the value.
void	setMediaTxIP(java.lang.String value) Sets the value.
void	setMediaTxPort(java.lang.Long value) Sets the value.
void	setMmsId(java.lang.Long value) Sets the value.
void	setOriginalTo(java.lang.String value) Sets the value.
void	setReturnValue(CuaeCommon.CuaeResult value) Sets the value.
void	setTo(java.lang.String value) Sets the value.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

returnValue

public CuaeCommon.CuaeResult returnValue

callId

public java.lang.String callId

Unique identifier used to identify this call in all subsequent Call Control API operations. This is the same value that will be returned as the event parameter CallId in the MakeCall_Complete event or in the MakeCall_Failed event.

mmsId

public java.lang.Long mmsId

Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine. This event parameter will not be populated if the call is in a peer-to-peer relationship. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

to

public java.lang.String to

The final called number for this call. If the call was redirected, transferred, or otherwise translated during call routing, this field should reflect the final called number. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

from

public java.lang.String from

The calling number, or caller ID, for this call. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

originalTo

public java.lang.String originalTo

The originally dialed number for this call. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

connectionId

public java.lang.String connectionId

Unique identifier used to identify this connection in all subsequent Media Control API operations. This connection may not be fully connected, and therefore not ready to use in most Media Control API by the time it is returned to the script if WaitForMedia is not the default TxRx. This event parameter will not be populated if the call is in a peer-to-peer relationship. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

conferenceId

public java.lang.String conferenceId

Unique identifier for the conference that this connection was placed in. This field is valid only if Conference was specified as true in the action. In the case that Conference was set to true and the ConferenceId action parameter was specified, this event parameter will be that same value. If the ConferenceId action parameter was not specified, then this will be a new ID for the new conference. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxIP

public java.lang.String mediaTxIP

The IP address that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxPort

public java.lang.Long mediaTxPort

The port that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxCodec

public java.lang.String mediaTxCodec

The codec that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxFramesize

public java.lang.Long mediaTxFramesize

The framesize that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

endReason

public java.lang.String endReason

The condition which caused the call leg to fail to complete. Note that the underlying protocol puts inherent limitations on how well each EndReason is supported. Possible values for EndReason are as follows: Normal - Ringout - Indicates that the call rang until a ring timeout was reached. Busy - Indicates that the call could not be completed because the destination is already engaged in a call. Unreachable - Indicates that the specified To destination could not be routed to. InternalError - Indicates that the underlying protocol stack had a fatal error that forced termination of the call. Unknown - Indicates that the call was terminated for an unexpected or unknown reason. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Failed".

Constructor Detail

CallControl.MakeCallResult

public CallControl.MakeCallResult()

Constructs the MakeCallResult. Don't init any fields.

CallControl.MakeCallResult

public CallControl.MakeCallResult(CuaeCommon.CuaeResult returnValue,
                                  java.lang.String callId,
                                  java.lang.Long mmsId,
                                  java.lang.String to,
                                  java.lang.String from,
                                  java.lang.String originalTo,
                                  java.lang.String connectionId,
                                  java.lang.String conferenceId,
                                  java.lang.String mediaTxIP,
                                  java.lang.Long mediaTxPort,
                                  java.lang.String mediaTxCodec,
                                  java.lang.Long mediaTxFramesize,
                                  java.lang.String endReason)

Constructs the MakeCallResult.

Parameters:

callId - Unique identifier used to identify this call in all subsequent Call callId Control API operations. This is the same value that will be returned as callId the event parameter CallId in the MakeCall_Complete event or in the callId MakeCall_Failed event. callId

mmsId - Unique identifier used to identify the media engine in control of this mmsId connection. A common use for this ID is to ensure that other connections mmsId which will ultimately be conferenced with this connection are all created mmsId on the same media engine. This correlation is necessary because all mmsId connections in a single conference must all reside on the same media mmsId engine. This event parameter will not be populated if the call is in a mmsId peer-to-peer relationship. mmsId mmsId This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

to - The final called number for this call. If the call was redirected, to transferred, or otherwise translated during call routing, this field should to reflect the final called number. to to This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

from - The calling number, or caller ID, for this call. from from This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

originalTo - The originally dialed number for this call. originalTo originalTo This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

connectionId - Unique identifier used to identify this connection in all subsequent Media connectionId Control API operations. This connection may not be fully connected, and connectionId therefore not ready to use in most Media Control API by the time it is connectionId returned to the script if WaitForMedia is not the default TxRx. This event connectionId parameter will not be populated if the call is in a peer-to-peer connectionId relationship. connectionId connectionId This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

conferenceId - Unique identifier for the conference that this connection was placed in. conferenceId This field is valid only if Conference was specified as true in the action. conferenceId In the case that Conference was set to true and the ConferenceId action conferenceId parameter was specified, this event parameter will be that same value. If conferenceId the ConferenceId action parameter was not specified, then this will be a conferenceId new ID for the new conference. conferenceId conferenceId This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxIP - The IP address that the media engine connection should send audio to. This mediaTxIP field can only be relied on if WaitForMedia has been set to a value of Tx mediaTxIP or TxRx. However, regardless if this field is available as an event mediaTxIP parameter, the application server will associate the correct value for this mediaTxIP parameter to the connection created for this call when it becomes available mediaTxIP at the protocol layer. mediaTxIP mediaTxIP This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxPort - The port that the media engine connection should send audio to. This field mediaTxPort can only be relied on if WaitForMedia has been set to a value of Tx or mediaTxPort TxRx. However, regardless if this field is available as an event parameter, mediaTxPort the application server will associate the correct value for this parameter mediaTxPort to the connection created for this call when it becomes available at the mediaTxPort protocol layer. mediaTxPort mediaTxPort This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxCodec - The codec that the media engine connection should use when sending audio. mediaTxCodec This field can only be relied on if WaitForMedia has been set to a value of mediaTxCodec Tx or TxRx. However, regardless if this field is available as an event mediaTxCodec parameter, the application server will associate the correct value for this mediaTxCodec parameter to the connection created for this call when it becomes available mediaTxCodec at the protocol layer. mediaTxCodec mediaTxCodec This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

mediaTxFramesize - The framesize that the media engine connection should use when sending mediaTxFramesize audio. This field can only be relied on if WaitForMedia has been set to a mediaTxFramesize value of Tx or TxRx. However, regardless if this field is available as an mediaTxFramesize event parameter, the application server will associate the correct value mediaTxFramesize for this parameter to the connection created for this call when it becomes mediaTxFramesize available at the protocol layer. mediaTxFramesize mediaTxFramesize This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

endReason - The condition which caused the call leg to fail to complete. Note that the endReason underlying protocol puts inherent limitations on how well each EndReason is endReason supported. Possible values for EndReason are as follows: endReason endReason Normal - endReason Ringout - Indicates that the call rang until a ring timeout was reached. endReason Busy - Indicates that the call could not be completed because the endReason destination is already engaged in a call. endReason Unreachable - Indicates that the specified To destination could not be endReason routed to. endReason InternalError - Indicates that the underlying protocol stack had a fatal endReason error that forced termination of the call. endReason Unknown - Indicates that the call was terminated for an unexpected or endReason unknown reason. endReason endReason This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Failed".

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getReturnValue

public CuaeCommon.CuaeResult getReturnValue()

Gets the value.

Returns:

the value.

setReturnValue

public void setReturnValue(CuaeCommon.CuaeResult value)

Sets the value.

Parameters:

value - the value.

getCallId

public java.lang.String getCallId()

Gets the value. Unique identifier used to identify this call in all subsequent Call Control API operations. This is the same value that will be returned as the event parameter CallId in the MakeCall_Complete event or in the MakeCall_Failed event.

Returns:

the value.

setCallId

public void setCallId(java.lang.String value)

Sets the value. Unique identifier used to identify this call in all subsequent Call Control API operations. This is the same value that will be returned as the event parameter CallId in the MakeCall_Complete event or in the MakeCall_Failed event.

Parameters:

value - the value.

getMmsId

public java.lang.Long getMmsId()

Gets the value. Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine. This event parameter will not be populated if the call is in a peer-to-peer relationship. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setMmsId

public void setMmsId(java.lang.Long value)

Sets the value. Unique identifier used to identify the media engine in control of this connection. A common use for this ID is to ensure that other connections which will ultimately be conferenced with this connection are all created on the same media engine. This correlation is necessary because all connections in a single conference must all reside on the same media engine. This event parameter will not be populated if the call is in a peer-to-peer relationship. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getTo

public java.lang.String getTo()

Gets the value. The final called number for this call. If the call was redirected, transferred, or otherwise translated during call routing, this field should reflect the final called number. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setTo

public void setTo(java.lang.String value)

Sets the value. The final called number for this call. If the call was redirected, transferred, or otherwise translated during call routing, this field should reflect the final called number. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getFrom

public java.lang.String getFrom()

Gets the value. The calling number, or caller ID, for this call. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setFrom

public void setFrom(java.lang.String value)

Sets the value. The calling number, or caller ID, for this call. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getOriginalTo

public java.lang.String getOriginalTo()

Gets the value. The originally dialed number for this call. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setOriginalTo

public void setOriginalTo(java.lang.String value)

Sets the value. The originally dialed number for this call. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getConnectionId

public java.lang.String getConnectionId()

Gets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. This connection may not be fully connected, and therefore not ready to use in most Media Control API by the time it is returned to the script if WaitForMedia is not the default TxRx. This event parameter will not be populated if the call is in a peer-to-peer relationship. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setConnectionId

public void setConnectionId(java.lang.String value)

Sets the value. Unique identifier used to identify this connection in all subsequent Media Control API operations. This connection may not be fully connected, and therefore not ready to use in most Media Control API by the time it is returned to the script if WaitForMedia is not the default TxRx. This event parameter will not be populated if the call is in a peer-to-peer relationship. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getConferenceId

public java.lang.String getConferenceId()

Gets the value. Unique identifier for the conference that this connection was placed in. This field is valid only if Conference was specified as true in the action. In the case that Conference was set to true and the ConferenceId action parameter was specified, this event parameter will be that same value. If the ConferenceId action parameter was not specified, then this will be a new ID for the new conference. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setConferenceId

public void setConferenceId(java.lang.String value)

Sets the value. Unique identifier for the conference that this connection was placed in. This field is valid only if Conference was specified as true in the action. In the case that Conference was set to true and the ConferenceId action parameter was specified, this event parameter will be that same value. If the ConferenceId action parameter was not specified, then this will be a new ID for the new conference. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getMediaTxIP

public java.lang.String getMediaTxIP()

Gets the value. The IP address that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setMediaTxIP

public void setMediaTxIP(java.lang.String value)

Sets the value. The IP address that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getMediaTxPort

public java.lang.Long getMediaTxPort()

Gets the value. The port that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setMediaTxPort

public void setMediaTxPort(java.lang.Long value)

Sets the value. The port that the media engine connection should send audio to. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getMediaTxCodec

public java.lang.String getMediaTxCodec()

Gets the value. The codec that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setMediaTxCodec

public void setMediaTxCodec(java.lang.String value)

Sets the value. The codec that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getMediaTxFramesize

public java.lang.Long getMediaTxFramesize()

Gets the value. The framesize that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Returns:

the value.

setMediaTxFramesize

public void setMediaTxFramesize(java.lang.Long value)

Sets the value. The framesize that the media engine connection should use when sending audio. This field can only be relied on if WaitForMedia has been set to a value of Tx or TxRx. However, regardless if this field is available as an event parameter, the application server will associate the correct value for this parameter to the connection created for this call when it becomes available at the protocol layer. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Complete".

Parameters:

value - the value.

getEndReason

public java.lang.String getEndReason()

Gets the value. The condition which caused the call leg to fail to complete. Note that the underlying protocol puts inherent limitations on how well each EndReason is supported. Possible values for EndReason are as follows: Normal - Ringout - Indicates that the call rang until a ring timeout was reached. Busy - Indicates that the call could not be completed because the destination is already engaged in a call. Unreachable - Indicates that the specified To destination could not be routed to. InternalError - Indicates that the underlying protocol stack had a fatal error that forced termination of the call. Unknown - Indicates that the call was terminated for an unexpected or unknown reason. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Failed".

Returns:

the value.

setEndReason

public void setEndReason(java.lang.String value)

Sets the value. The condition which caused the call leg to fail to complete. Note that the underlying protocol puts inherent limitations on how well each EndReason is supported. Possible values for EndReason are as follows: Normal - Ringout - Indicates that the call rang until a ring timeout was reached. Busy - Indicates that the call could not be completed because the destination is already engaged in a call. Unreachable - Indicates that the specified To destination could not be routed to. InternalError - Indicates that the underlying protocol stack had a fatal error that forced termination of the call. Unknown - Indicates that the call was terminated for an unexpected or unknown reason. This is a parameter from asyncCallback event "Metreos.CallControl.MakeCall_Failed".

Parameters:

value - the value.