cisco.uc.cuae.legacy
Class JTapi.JTapiStartMonitoringResult

java.lang.Object
  cisco.uc.cuae.legacy.JTapi.JTapiStartMonitoringResult

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

JTapi

public static class JTapi.JTapiStartMonitoringResult
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	resultCode Describes the result of the action.
CuaeCommon.CuaeResult	returnValue

Constructor Summary

JTapi.JTapiStartMonitoringResult()
Constructs the JTapiStartMonitoringResult.

JTapi.JTapiStartMonitoringResult(CuaeCommon.CuaeResult returnValue, java.lang.String resultCode, java.lang.String callId)
Constructs the JTapiStartMonitoringResult.

Method Summary

java.lang.String	getCallId() Gets the value.
java.lang.String	getResultCode() Gets the value.
CuaeCommon.CuaeResult	getReturnValue() Gets the value.
void	setCallId(java.lang.String value) Sets the value.
void	setResultCode(java.lang.String value) Sets the value.
void	setReturnValue(CuaeCommon.CuaeResult 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

resultCode

public java.lang.String resultCode

Describes the result of the action. If a failure occured, will indicate the cause of the failure. The following are possible values: Success - No DevicePoolName and DeviceName specified - ListenerDevicePool or ListenerDeviceName must be specified. Failed to get Device for the specified DevicePool - The specified ListenerDevicePool had no available devices. DevicePool does not exist - The specified ListenerDevicePool does not exist. Device is not monitored - The specified TargetDeviceName is not currently JTAPI-controlled by the application server. Device type is not CtiMonitored - The specified TargetDeviceName is not controllable with JTAPI. Failed to get specified call - The specified TargetCallId does not exist. Internal Error: Failed to add Call - No Description. Internal Error: Timed out waiting for response - No Description. Internal Error: Failed to send message to JTAPI Service - No Description. InvalidDeviceName - The TargetDeviceName device name was invalid. Originates from JTAPI. InvalidDeviceType - The type of device represented by TargetDeviceName was invalid. Originates from JTAPI. UnknownMessageType - Originates from JTAPI. InvalidDN - The TargetLineDN does not exist on TargetDeviceName. Originates from JTAPI. NoProvider - Originates from JTAPI. GeneralFailure - Originates from JTAPI. CallIdUnknown - The TargetCallId specified was invalid. Originates from JTAPI. CodecNotSupported - Originates from JTAPI. MissingField - Originates from JTAPI. InvalidDestination - Originates from JTAPI. PlatformException - Originates from JTAPI. DeviceNotMonitored - The device is not currently monitored. Originates from JTAPI. MethodNotSupported - Originates from JTAPI.

callId

public java.lang.String callId

Unique identifier used to identify this call in all subsequent Call Control API operations.

Constructor Detail

JTapi.JTapiStartMonitoringResult

public JTapi.JTapiStartMonitoringResult()

Constructs the JTapiStartMonitoringResult. Don't init any fields.

JTapi.JTapiStartMonitoringResult

public JTapi.JTapiStartMonitoringResult(CuaeCommon.CuaeResult returnValue,
                                        java.lang.String resultCode,
                                        java.lang.String callId)

Constructs the JTapiStartMonitoringResult.

Parameters:

resultCode - Describes the result of the action. If a failure occured, will indicate resultCode the cause of the failure. The following are possible values: resultCode resultCode Success - resultCode No DevicePoolName and DeviceName specified - ListenerDevicePool or resultCode ListenerDeviceName must be specified. resultCode Failed to get Device for the specified DevicePool - The specified resultCode ListenerDevicePool had no available devices. resultCode DevicePool does not exist - The specified ListenerDevicePool does not resultCode exist. resultCode Device is not monitored - The specified TargetDeviceName is not resultCode currently JTAPI-controlled by the application server. resultCode Device type is not CtiMonitored - The specified TargetDeviceName is not resultCode controllable with JTAPI. resultCode Failed to get specified call - The specified TargetCallId does not resultCode exist. resultCode Internal Error: Failed to add Call - No Description. resultCode Internal Error: Timed out waiting for response - No Description. resultCode Internal Error: Failed to send message to JTAPI Service - No resultCode Description. resultCode InvalidDeviceName - The TargetDeviceName device name was invalid. resultCode Originates from JTAPI. resultCode InvalidDeviceType - The type of device represented by TargetDeviceName resultCode was invalid. Originates from JTAPI. resultCode UnknownMessageType - Originates from JTAPI. resultCode InvalidDN - The TargetLineDN does not exist on TargetDeviceName. resultCode Originates from JTAPI. resultCode NoProvider - Originates from JTAPI. resultCode GeneralFailure - Originates from JTAPI. resultCode CallIdUnknown - The TargetCallId specified was invalid. Originates from resultCode JTAPI. resultCode CodecNotSupported - Originates from JTAPI. resultCode MissingField - Originates from JTAPI. resultCode InvalidDestination - Originates from JTAPI. resultCode PlatformException - Originates from JTAPI. resultCode DeviceNotMonitored - The device is not currently monitored. Originates resultCode from JTAPI. resultCode MethodNotSupported - Originates from JTAPI. resultCode

callId - Unique identifier used to identify this call in all subsequent Call callId Control API operations. callId

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.

getResultCode

public java.lang.String getResultCode()

Gets the value. Describes the result of the action. If a failure occured, will indicate the cause of the failure. The following are possible values: Success - No DevicePoolName and DeviceName specified - ListenerDevicePool or ListenerDeviceName must be specified. Failed to get Device for the specified DevicePool - The specified ListenerDevicePool had no available devices. DevicePool does not exist - The specified ListenerDevicePool does not exist. Device is not monitored - The specified TargetDeviceName is not currently JTAPI-controlled by the application server. Device type is not CtiMonitored - The specified TargetDeviceName is not controllable with JTAPI. Failed to get specified call - The specified TargetCallId does not exist. Internal Error: Failed to add Call - No Description. Internal Error: Timed out waiting for response - No Description. Internal Error: Failed to send message to JTAPI Service - No Description. InvalidDeviceName - The TargetDeviceName device name was invalid. Originates from JTAPI. InvalidDeviceType - The type of device represented by TargetDeviceName was invalid. Originates from JTAPI. UnknownMessageType - Originates from JTAPI. InvalidDN - The TargetLineDN does not exist on TargetDeviceName. Originates from JTAPI. NoProvider - Originates from JTAPI. GeneralFailure - Originates from JTAPI. CallIdUnknown - The TargetCallId specified was invalid. Originates from JTAPI. CodecNotSupported - Originates from JTAPI. MissingField - Originates from JTAPI. InvalidDestination - Originates from JTAPI. PlatformException - Originates from JTAPI. DeviceNotMonitored - The device is not currently monitored. Originates from JTAPI. MethodNotSupported - Originates from JTAPI.

Returns:

the value.

setResultCode

public void setResultCode(java.lang.String value)

Sets the value. Describes the result of the action. If a failure occured, will indicate the cause of the failure. The following are possible values: Success - No DevicePoolName and DeviceName specified - ListenerDevicePool or ListenerDeviceName must be specified. Failed to get Device for the specified DevicePool - The specified ListenerDevicePool had no available devices. DevicePool does not exist - The specified ListenerDevicePool does not exist. Device is not monitored - The specified TargetDeviceName is not currently JTAPI-controlled by the application server. Device type is not CtiMonitored - The specified TargetDeviceName is not controllable with JTAPI. Failed to get specified call - The specified TargetCallId does not exist. Internal Error: Failed to add Call - No Description. Internal Error: Timed out waiting for response - No Description. Internal Error: Failed to send message to JTAPI Service - No Description. InvalidDeviceName - The TargetDeviceName device name was invalid. Originates from JTAPI. InvalidDeviceType - The type of device represented by TargetDeviceName was invalid. Originates from JTAPI. UnknownMessageType - Originates from JTAPI. InvalidDN - The TargetLineDN does not exist on TargetDeviceName. Originates from JTAPI. NoProvider - Originates from JTAPI. GeneralFailure - Originates from JTAPI. CallIdUnknown - The TargetCallId specified was invalid. Originates from JTAPI. CodecNotSupported - Originates from JTAPI. MissingField - Originates from JTAPI. InvalidDestination - Originates from JTAPI. PlatformException - Originates from JTAPI. DeviceNotMonitored - The device is not currently monitored. Originates from JTAPI. MethodNotSupported - Originates from JTAPI.

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.

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.

Parameters:

value - the value.