org.xins.client

Interface XINSCallResultData

All Known Implementing Classes:

AbstractCAPIErrorCodeException, DisabledFunctionException, InternalErrorException, InvalidRequestException, StandardErrorCodeException, UnsuccessfulXINSCallException, XINSCallResult

public interface XINSCallResultData

Data part of a XINS call result.

Since:

XINS 1.0.0

Version:

$Revision: 1.15 $ $Date: 2010/11/18 20:35:05 $

Author:

Ernst de Haan

Method Summary

Methods

Modifier and Type	Method and Description
Element	getDataElement() Returns the optional extra data.
String	getErrorCode() Returns the error code.
Map<String,String>	getParameters() Gets all parameters.

Method Detail

getErrorCode

String getErrorCode()

Returns the error code. If null is returned the call was successful and thus no error code was returned. Otherwise the call was unsuccessful.

This method will never return an empty string, so if the result is not null, then it is safe to assume the length of the string is at least 1 character.

Returns:

the returned error code, or null if the call was successful.

getParameters

Map<String,String> getParameters()

Gets all parameters.

Returns:

a Map with all parameters, or null if there are none.

getDataElement

Element getDataElement()

Returns the optional extra data. The data is an XML Element, or null.

Returns:

the extra data as an XML Element, can be null;