public class EPPOrgCheckResult extends java.lang.Object implements EPPCodecComponent
EPPOrgCheckResult
is used to represent the for the check of
an individual org. The org information includes the org
identifier, whether the org identifier is available, and optionally the
reason that the org identifier is not available.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
XML local name for
EPPOrgCheckResult . |
static java.lang.String |
ELM_NAME
XML root tag for
EPPOrgCheckResult . |
Constructor and Description |
---|
EPPOrgCheckResult()
Default constructor for
EPPOrgCheckResult . |
EPPOrgCheckResult(java.lang.String aOrgId,
boolean aAvailable)
Constructor for
EPPOrgCheckResult that takes org
identifier and whether the org identifier is available. |
EPPOrgCheckResult(java.lang.String aOrgId,
java.lang.String aReason)
Constructor for
EPPOrgCheckResult that is used for
unavailable org identifiers providing the reason the org
identifier is not available. |
EPPOrgCheckResult(java.lang.String aOrgId,
java.lang.String aReason,
java.lang.String aReasonLang)
Constructor for
EPPOrgCheckResult that is used for
unavailable org identifiers providing the reason the org
identifier is not available with the reason language. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
clone an
EPPCodecComponent . |
void |
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes.
|
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree.
|
boolean |
equals(java.lang.Object aObject)
Compare an instance of
EPPOrgCheckResult with this
instance. |
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getOrgId()
Gets the org identifier.
|
java.lang.String |
getReason()
Gets the reason that the org identifier is not available.
|
java.lang.String |
getReasonLang()
Gets the reason language value.
|
boolean |
hasReason()
Is the reason defined?
|
boolean |
hasReasonLang()
Is the reason language defined?
|
boolean |
isAvailable()
Is the org identifier available?
|
void |
setAvailable(boolean aAvailable)
Sets the org identifier is available.
|
void |
setOrgId(java.lang.String aOrgId)
Sets the org identifier.
|
void |
setReason(java.lang.String aReason)
Sets the reason that the org identifier is not available.
|
void |
setReasonLang(java.lang.String aReasonLang)
Sets the reason language value.
|
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
EPPOrgCheckResult
.public static final java.lang.String ELM_NAME
EPPOrgCheckResult
.public EPPOrgCheckResult()
EPPOrgCheckResult
.public EPPOrgCheckResult(java.lang.String aOrgId, boolean aAvailable)
EPPOrgCheckResult
that takes org
identifier and whether the org identifier is available.aOrgId
- The org identifieraAvailable
- Is the org identifier available?public EPPOrgCheckResult(java.lang.String aOrgId, java.lang.String aReason)
EPPOrgCheckResult
that is used for
unavailable org identifiers providing the reason the org
identifier is not available.aOrgId
- The org identifieraReason
- Reason that the org identifier is not available.public EPPOrgCheckResult(java.lang.String aOrgId, java.lang.String aReason, java.lang.String aReasonLang)
EPPOrgCheckResult
that is used for
unavailable org identifiers providing the reason the org
identifier is not available with the reason language.aOrgId
- The org identifieraReason
- Reason that the org identifier is not available.aReasonLang
- Reason language for reason value.public java.lang.String getOrgId()
null
otherwise.public void setOrgId(java.lang.String aOrgId)
aOrgId
- The org identifierpublic boolean isAvailable()
true
if the org identifier is available;
false
otherwise.public void setAvailable(boolean aAvailable)
aAvailable
- true
if the org identifier is available;
false
otherwise.public boolean hasReason()
true
if the reason is defined; false
otherwise.public java.lang.String getReason()
null
otherwise.public void setReason(java.lang.String aReason)
aReason
- Reason that the org identifier is not available. Set to
null
to clear the reason.public boolean hasReasonLang()
true
if the reason language is defined;
false
otherwise.public java.lang.String getReasonLang()
null
otherwise.public void setReasonLang(java.lang.String aReasonLang)
aReasonLang
- Reason language for reason value.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- DOM Document, which acts is an Element factoryEPPEncodeException
- Error encoding EPPOrgCheckResult
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
aElement
argument represents the root DOM element and is
used to traverse the DOM nodes for instance attribute values.decode
in interface EPPCodecComponent
aElement
- Element
to decodeEPPDecodeException
- Error decoding Element
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPCodecComponent
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPOrgCheckResult
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 boolean equals(java.lang.Object aObject)
EPPOrgCheckResult
with this
instance.equals
in class java.lang.Object
aObject
- Object to compare with.true
if equal; false
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.