| java.lang.Object
 org.xins.common.service.CallResult
org.xins.client.XINSCallResult
| XINSCallResult | | final public class XINSCallResult extends CallResult implements XINSCallResultData(Code) | | Successful result of a call to a XINS service. It may be that some targets
failed before a target returned a successful result. All the failures are
also stored in this object.
When a XINSCallResult instance is created, information must
be passed both about the successful call (which target successfully
returned a result, how long did it take, what was the result) and about the
unsuccessful calls (to which targets were they, what was the error, etc.)
While a
XINSCallResultData object describes the result of a call
to an single target, a XINSCallResultData also describes all
failed calls that happened before.
version:
$Revision: 1.26 $ $Date: 2007/03/15 17:08:27 $
author:
Ernst de Haan
since:
XINS 1.0.0 |
| XINSCallResult | | XINSCallResult(XINSCallRequest request, TargetDescriptor succeededTarget, long duration, CallExceptionList exceptions, XINSCallResultData data) throws IllegalArgumentException(Code) | | Constructs a new XINSCallResult object.
Parameters:
request - the original XINSCallRequest that was used to perform thecall, cannot be null.
Parameters:
succeededTarget - the TargetDescriptor that was used to successfully get theresult, cannot be null.
Parameters:
duration - the call duration, should be >= 0.
Parameters:
exceptions - the list of org.xins.common.service.CallExceptions, collectedin a CallExceptionList object, or null if thefirst call attempt succeeded.
Parameters:
data - the XINSCallResultData returned from the call, cannot benull.
throws:
IllegalArgumentException - if request == null|| succeededTarget == null|| data == null|| duration < 0. |
| getDataElement | | public Element getDataElement()(Code) | | Returns the optional extra data. The data is an XML
Element ,
or null.
the extra data as an XML Element, can benull. |
| getErrorCode | | public String getErrorCode()(Code) | | 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.
the returned error code, or null if the call wassuccessful. |
| getParameter | | public String getParameter(String name) throws IllegalArgumentException(Code) | | Gets the value of the specified parameter.
Parameters:
name - the parameter element name, not null.string containing the value of the parameter element,or null if the parameter has no value.
throws:
IllegalArgumentException - if name == null. |
|
|