org.xins.client
Class UnsuccessfulXINSCallException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          org.xins.common.service.CallException
              org.xins.client.XINSCallException
                  org.xins.client.UnsuccessfulXINSCallException

All Implemented Interfaces:

Serializable, XINSCallResultData

Direct Known Subclasses:

AbstractCAPIErrorCodeException, StandardErrorCodeException

public class UnsuccessfulXINSCallException

extends XINSCallException

implements XINSCallResultData

Exception that indicates that a result code was returned by the API call.

Since:

XINS 1.0.0

Version:

$Revision: 1.25 $ $Date: 2006/08/28 09:12:30 $

Author:

Ernst de Haan

See Also:

Serialized Form

Method Summary

DataElement	getDataElement() Returns the optional extra data.
String	getErrorCode() Returns the error code.
String	getParameter(String name) Gets the value of the specified returned parameter.
PropertyReader	getParameters() Gets all returned parameters.
ErrorCodeSpec.Type	getType() Returns the type of the error code.

Methods inherited from class org.xins.common.service.CallException

getDetail, getDuration, getMessage, getNext, getRequest, getTarget

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Method Detail

getErrorCode

public final String getErrorCode()

Returns the error code.

Specified by:

getErrorCode in interface XINSCallResultData

Returns:

the error code, never null.

getParameters

public final PropertyReader getParameters()

Gets all returned parameters.

Specified by:

getParameters in interface XINSCallResultData

Returns:

a PropertyReader containing all parameters, or null if there are none.

getParameter

public final String getParameter(String name)
                          throws IllegalArgumentException

Gets the value of the specified returned parameter.

Parameters:

name - the parameter name, not null.

Returns:

the value of the parameter, not null.

Throws:

IllegalArgumentException - if name == null.

getDataElement

public final DataElement getDataElement()

Returns the optional extra data.

Specified by:

getDataElement in interface XINSCallResultData

Returns:

the extra data as a DataElement, can be null;

getType

public final ErrorCodeSpec.Type getType()

Returns the type of the error code.

Returns:

the type as a ErrorCodeSpec.Type, can be null if it's unknown.

Since:

XINS 1.4.0