Package com.novomind.ecom.api.iagent.exception

Class AgentDeviceOperationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.novomind.ecom.api.iagent.exception.PhoneSystemException

com.novomind.ecom.api.iagent.exception.AgentDeviceOperationException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AgentDeviceLoginException

public class AgentDeviceOperationException
extends PhoneSystemException

Signals that an exception has occurred during agent device operation.

Since:

11.27

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected final User	agent	the agent user associated with this exception
protected final String	deviceId	the id of the device associated with this exception

Fields inherited from class com.novomind.ecom.api.iagent.exception.PhoneSystemException

errorCode

Constructor Summary

Constructors

Constructor	Description
AgentDeviceOperationException(String message, int errorCode, ConnectedAgentDevice connectedAgentDevice)	Constructs a new AgentDeviceOperationException with the specified detail message, error code and connected agent device.
AgentDeviceOperationException(String message, int errorCode, User agent, String deviceId)	Constructs a new AgentDeviceOperationException with the specified detail message, error code, agent and device id.
AgentDeviceOperationException(String message, int errorCode, User agent, String deviceId, Throwable cause)	Constructs a new AgentDeviceOperationException with the specified detail message, error code, agent, device id and cause.

Method Summary

Modifier and Type	Method	Description
User	getAgent()	Returns the agent that caused this exception.
String	getDeviceId()	Returns the device id associated with this exception.
String	toString()

Methods inherited from class com.novomind.ecom.api.iagent.exception.PhoneSystemException

getErrorCode

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Field Details

agent

protected final transient User agent

the agent user associated with this exception

deviceId

protected final String deviceId

the id of the device associated with this exception

Constructor Details

AgentDeviceOperationException

public AgentDeviceOperationException(String message,
 int errorCode,
 ConnectedAgentDevice connectedAgentDevice)

Constructs a new AgentDeviceOperationException with the specified detail message, error code and connected agent device.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

errorCode - the optional error code of the exception (which is saved for later retrieval by the PhoneSystemException.getErrorCode() method).

connectedAgentDevice - the ConnectedAgentDevice that caused the exception

Since:

11.27

AgentDeviceOperationException

public AgentDeviceOperationException(String message,
 int errorCode,
 User agent,
 String deviceId)

Constructs a new AgentDeviceOperationException with the specified detail message, error code, agent and device id.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

errorCode - the optional error code of the exception (which is saved for later retrieval by the PhoneSystemException.getErrorCode() method).

agent - the user that caused the exception (which is saved for later retrieval by the getAgent() method).

deviceId - the id of the device (which is saved for later retrieval by the getDeviceId() method).

Since:

11.27

AgentDeviceOperationException

public AgentDeviceOperationException(String message,
 int errorCode,
 User agent,
 String deviceId,
 Throwable cause)

Constructs a new AgentDeviceOperationException with the specified detail message, error code, agent, device id and cause.

Parameters:

message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

errorCode - the optional error code of the exception (which is saved for later retrieval by the PhoneSystemException.getErrorCode() method).

agent - the user that caused the exception (which is saved for later retrieval by the getAgent() method).

deviceId - the id of the device (which is saved for later retrieval by the getDeviceId() method).

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

Since:

11.27

Method Details

getAgent

public User getAgent()

Returns the agent that caused this exception.

Returns:

the agent

Since:

11.27

getDeviceId

public String getDeviceId()

Returns the device id associated with this exception.

Returns:

the deviceId

Since:

11.27

toString

public String toString()

Overrides:

toString in class PhoneSystemException