public class EPPValidateCheckResult extends java.lang.Object implements EPPCodecComponent
EPPValidateCheckResult
represents the result of an individual contact
validation. The attributes of EPPValidateCheckResult
include the
contact identifier, the result code, and zero or more key value pairs.EPPValidateCheckResp
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
Constant for the result local name
|
static java.lang.String |
ELM_NAME
Constant for the result tag
|
Constructor and Description |
---|
EPPValidateCheckResult()
Default constructor for
EPPValidateCheckResult . |
EPPValidateCheckResult(java.lang.String aId,
int aCode)
Constructor for
EPPValidateCheckResult that includes the required
attributes of the contact identifier and the result code. |
Modifier and Type | Method and Description |
---|---|
void |
addKeyValue(EPPValidateKeyValue aKeyValue)
Adds a key value pair to the list of key value pairs.
|
java.lang.Object |
clone()
Clone
EPPValidateCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPValidateCheckResult attributes from the aElement DOM
Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the
EPPValidateCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPValidateCheckResult with this instance. |
int |
getCode()
Gets the result code.
|
java.lang.String |
getId()
Gets the contact identifier.
|
java.util.List<EPPValidateKeyValue> |
getKeyValues()
Gets the full list of key value pairs.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
void |
setCode(int aCode)
Sets the result code.
|
void |
setId(java.lang.String aId)
Sets the contact identifier.
|
void |
setKeyValues(java.util.List<EPPValidateKeyValue> aKeyValues)
Sets the full list of key value pairs.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String ELM_LOCALNAME
public static final java.lang.String ELM_NAME
public EPPValidateCheckResult()
EPPValidateCheckResult
.public EPPValidateCheckResult(java.lang.String aId, int aCode)
EPPValidateCheckResult
that includes the required
attributes of the contact identifier and the result code.aId
- Contact identifieraResultCode
- Must be one of the EPPResult
result code constant values.public java.lang.String getId()
null
otherwise.public void setId(java.lang.String aId)
aId
- The contact identifierpublic int getCode()
EPPResult
result code constant values if defined; -1
otherwise.public void setCode(int aCode)
aCode
- Must be one of the EPPResult
result code constant values.public void addKeyValue(EPPValidateKeyValue aKeyValue)
aKeyValue
- Key value pair to add to the listpublic void setKeyValues(java.util.List<EPPValidateKeyValue> aKeyValues)
aKeyValues
- List of EPPValidateKeyValue
instances.public java.util.List<EPPValidateKeyValue> getKeyValues()
EPPValidateKeyValue
instances.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPValidateCheckResult
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPValidateCheckResult
instance.EPPEncodeException
- Unable to encode EPPValidateCheckResult
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPValidateCheckResult
attributes from the aElement DOM
Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPValidateCheckResult
from.EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPValidateCheckResult
with this instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if equal; false
otherwise.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPValidateCheckResult
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPValidateCheckResult
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.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.