Result (arjtk 3.11.4 API)

java.lang.Object
- com.ausregistry.jtoolkit2.se.Result

All Implemented Interfaces:

java.io.Serializable
```
public class Result
extends java.lang.Object
implements java.io.Serializable
```
This class models the result element of EPP responses. From RFC5730:
One or more <result> elements [...] document the success or failure of command execution. If the command was processed successfully, only one <result> element MUST be returned. If the command was not processed successfully, multiple <result> elements MAY be returned to document failure conditions. Each <result> element contains the following attribute and child elements.
See getX method descriptions for a description of the elements of a Result. Note that any DOM Node fields will not be serialized.

See Also:

Serialized Form

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getResultCode()` The code attribute of a result.
`java.lang.String`	`getResultExtReason(int nodeIndex)` Return the text content of the resultValue element at the specified index.
`java.lang.String[]`	`getResultExtValueReason()` The reason child elements of the extValue element of a result.
`org.w3c.dom.Node[]`	`getResultExtValueValue()` The value child elements of the extValue element of a result.
`java.lang.String`	`getResultMessage()` The msg element of a result.
`java.lang.String`	`getResultMessageLanguage()` The lang attribute of the msg element of a result.
`org.w3c.dom.NodeList`	`getResultValue()` The value elements of a result.
`java.lang.String[]`	`getValuesAsText()`
`boolean`	`hasResultExtReasons()` Indicate whether the result has any extValue/reason elements.
`boolean`	`hasResultValues()` Indicate whether the result has any resultValue elements.
`boolean`	`succeeded()` Whether the associated command succeeded or not.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - getResultCode
```
public int getResultCode()
```
    The code attribute of a result. From RFC5730:
    A "code" attribute whose value is a four-digit, decimal number that describes the success or failure of the command.
  - getResultMessage
```
public java.lang.String getResultMessage()
```
    The msg element of a result. From RFC5730:
    A <msg> element containing a human-readable description of the response code.
  - getResultMessageLanguage
```
public java.lang.String getResultMessageLanguage()
```
    The lang attribute of the msg element of a result. From RFC5730:
    The language of the response is identified via an OPTIONAL "lang" attribute. If not specified, the default attribute value MUST be "en" (English).
  - getResultExtValueValue
```
public org.w3c.dom.Node[] getResultExtValueValue()
```
    The value child elements of the extValue element of a result. From RFC5730:
    Zero or more OPTIONAL <extValue> elements that can be used to provide additional error diagnostic information, including:
    - A @{code <value>} element that identifies a client-provided element (including XML tag and value) that caused a server error condition.
  - getResultExtValueReason
```
public java.lang.String[] getResultExtValueReason()
```
    The reason child elements of the extValue element of a result. From RFC5730:
    Zero or more OPTIONAL <extValue> elements that can be used to provide additional error diagnostic information, including:
    - A <reason> element containing a human-readable message that describes the reason for the error.
    TODO provide interface to get language of each reason.
  - getValuesAsText
```
public java.lang.String[] getValuesAsText()
```
  - hasResultValues
```
public boolean hasResultValues()
```
    Indicate whether the result has any resultValue elements. This should be used to determine whether a call to getResultValue will return any nodes. If this returns false, getResultValue will return null.
  - hasResultExtReasons
```
public boolean hasResultExtReasons()
```
    Indicate whether the result has any extValue/reason elements. This should be used to determine whether a call to getResult will return any nodes. If this returns false, getResultValue will return null.
  - getResultValue
```
public org.w3c.dom.NodeList getResultValue()
```
    The value elements of a result. From RFC5730:
    Zero or more OPTIONAL <value> elements that identify a client-provided element (including XML tag and value) that caused a server error condition.
  - getResultExtReason
```
public java.lang.String getResultExtReason(int nodeIndex)
```
    Return the text content of the resultValue element at the specified index.
  - succeeded
```
public boolean succeeded()
```
    Whether the associated command succeeded or not. This can be used to reduce the amount of result checking, since if this returns true, then no further results should be available for the associated response.
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Result

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getResultCode

getResultMessage

getResultMessageLanguage

getResultExtValueValue

getResultExtValueReason

getValuesAsText

hasResultValues

hasResultExtReasons

getResultValue

getResultExtReason

succeeded

toString