|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPExtValue
public class EPPExtValue
elements that can be used to provide additional error diagnostic
information, including:
Field Summary | |
---|---|
static java.lang.String |
DEFAULT_LANG
The default language of the result message "en". |
static java.lang.String |
DEFAULT_VALUE
Default value which is used when there is only a reason and the server can not identify a single client element that caused the error. |
Constructor Summary | |
---|---|
EPPExtValue()
Default constructor for serialization. |
|
EPPExtValue(java.lang.String aReason)
Allocates a new EPPExtValue with only a reason
attributes specified. |
|
EPPExtValue(java.lang.String aReason,
EPPValue aValue)
Allocates a new EPPExtValue with both the
value and reason attributes specified. |
|
EPPExtValue(java.lang.String aReason,
java.lang.String aValue)
Allocates a new EPPExtValue with both the
value and reason attributes specified. |
|
EPPExtValue(java.lang.String aReason,
java.lang.String aValue,
java.lang.String aPrefix,
java.lang.String aNamespace)
Allocates a new EPPExtValue with all attributes specified. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPExtValue . |
void |
decode(org.w3c.dom.Element aElement)
decode EPPExtValue from a DOM element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode EPPExtValue into a DOM element tree. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPExtValue compare. |
java.lang.String |
getLang()
Gets the reason language. |
java.lang.String |
getReason()
Gets the human-readable message that describes the reason for the error. |
EPPValue |
getValue()
Gets the value element associated with the error. |
java.lang.String |
getValueStr()
Gets the value element String associated with the error. |
void |
setLang(java.lang.String aLang)
Sets the reason language. |
void |
setReason(java.lang.String aReason)
Sets the human-readable message that describes the reason for the error. |
void |
setValue(EPPValue aValue)
Sets the value associated with the error. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String DEFAULT_LANG
public static final java.lang.String DEFAULT_VALUE
Constructor Detail |
---|
public EPPExtValue()
value
and
reason
attributes must be set before calling
encode
.
public EPPExtValue(java.lang.String aReason)
EPPExtValue
with only a reason
attributes specified. The value will be set to the
DEFAULT_VALUE
constant, which indicates that no client
element is specified. The default XML prefix and XML namespace will be
used.
aReason
- Human-readable message that describes the reason for the
error.public EPPExtValue(java.lang.String aReason, java.lang.String aValue)
EPPExtValue
with both the
value
and reason
attributes specified. The
default XML prefix and XML namespace will be used.
aReason
- Human-readable message that describes the reason for the
error.aValue
- XML String
that identifies a client-provided
element (including XML tag and value) that caused a server
error. For example,
<domain:name>example.com</domain>.public EPPExtValue(java.lang.String aReason, EPPValue aValue)
EPPExtValue
with both the
value
and reason
attributes specified.
aReason
- Human-readable message that describes the reason for the
error.aValue
- Value will a value String
and XML prefix and
namespace.public EPPExtValue(java.lang.String aReason, java.lang.String aValue, java.lang.String aPrefix, java.lang.String aNamespace)
EPPExtValue
with all attributes specified.
This is a convenience constructor in place of using
EPPExtValue(String, EPPValue)
.
aReason
- Human-readable message that describes the reason for the
error.aValue
- XML String
that identifies a client-provided
element (including XML tag and value) that caused a server
error. For example,
<domain:name>example.com</domain>.aPrefix
- XML Namespace prefix. For example, "domain" or "epp".aNamespace
- XML Namespace URI. For example,
"urn:ietf:params:xml:ns:domain-1.0".Method Detail |
---|
public EPPValue getValue()
public void setValue(EPPValue aValue)
aValue
- The value object that includes the XML value with prefix
and namespace.public java.lang.String getValueStr()
String
associated with the error.
EPPValue String
value if defined;
null
otherwise.public java.lang.String getReason()
DEFAULT_LANG
, but the value can
be retrieved with the getLang
method.
public void setReason(java.lang.String aReason)
DEFAULT_LANG
, but can be set
with the setLang
method.
aReason
- Human-readable message that describes the reason for the
error.public java.lang.String getLang()
public void setLang(java.lang.String aLang)
aLang
- Language of the reason.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPExtValue
into a DOM element tree.
encode
in interface EPPCodecComponent
aDocument
- DOCUMENT ME!
EPPEncodeException
- Error encoding the DOM element tree.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPExtValue
from a DOM element tree. The
aElement
argument needs to be the "extValue" element.
decode
in interface EPPCodecComponent
aElement
- The "extValue" XML element.
EPPDecodeException
- Error decoding the DOM element tree.public boolean equals(java.lang.Object aObject)
EPPExtValue
compare.
equals
in class java.lang.Object
aObject
- EPPExtValue
instance to compare with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPExtValue
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPExtValue
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |