|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.nv.EPPNameVerificationCheckResult
public class EPPNameVerificationCheckResult
EPPNameVerificationCheckResult
represents the result of an
individual Name Verification label check. The attributes of
EPPNameVerificationCheckResult
include the label and a boolean
value indicating if the label can be created as a Domain Name Verification
(DNV) object. The OPTIONAL reason defines why a label cannot create a Domain
Name Verification (DNV) object. An OPTIONAL "restricted" is used to
indicate whether or not the label is a restricted label, with a default value
of false
.
com.verisign.epp.codec.domain.EPPNameVerificationCheckResp
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ELM_LOCALNAME
Constant for the result local name |
static java.lang.String |
ELM_NAME
Constant for the profile tag |
Constructor Summary | |
---|---|
EPPNameVerificationCheckResult()
Default constructor for EPPNameVerificationCheckResult . |
|
EPPNameVerificationCheckResult(java.lang.String aName,
boolean aIsAvailable)
Constructor for EPPNameVerificationCheckResult that includes
the label and the available flag. |
|
EPPNameVerificationCheckResult(java.lang.String aName,
boolean aIsAvailable,
java.lang.String aReason)
Constructor for EPPNameVerificationCheckResult that includes
the label, availability flag, and the availability reason. |
|
EPPNameVerificationCheckResult(java.lang.String aName,
boolean aIsAvailable,
java.lang.String aReason,
java.lang.String aLanguage,
boolean aRestricted)
Constructor for EPPNameVerificationCheckResult that includes
all attributes. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPNameVerificationCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPNameVerificationCheckResult 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 EPPNameVerificationCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of EPPNameVerificationCheckResult with
this instance. |
java.lang.String |
getLabel()
Gets the label associated with the result. |
java.lang.String |
getLanguage()
Gets the language attribute of the reason. |
java.lang.String |
getReason()
Gets the reason for the unavailable label. |
boolean |
isAvailable()
Gets if the label associated with EPPNameVerificationCheckResult is availability to be
created. |
boolean |
isRestricted()
Is the label a restricted label? |
void |
setIsAvailable(boolean aIsAvailable)
Sets if the label associated with EPPNameVerificationCheckResult is availability to be
created. |
void |
setLabel(java.lang.String aLabel)
Sets the label associated with the result. |
void |
setLanguage(java.lang.String aLanguage)
Sets language attribute of the reason. |
void |
setReason(java.lang.String aReason)
Sets the OPTIONAL reason for the unavailable label. |
void |
setRestricted(boolean aRestricted)
Sets if the label is a restricted label. |
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 ELM_LOCALNAME
public static final java.lang.String ELM_NAME
Constructor Detail |
---|
public EPPNameVerificationCheckResult()
EPPNameVerificationCheckResult
.
public EPPNameVerificationCheckResult(java.lang.String aName, boolean aIsAvailable)
EPPNameVerificationCheckResult
that includes
the label and the available flag.
aName
- Label associated with resultaIsAvailable
- Is the label available to be created?public EPPNameVerificationCheckResult(java.lang.String aName, boolean aIsAvailable, java.lang.String aReason)
EPPNameVerificationCheckResult
that includes
the label, availability flag, and the availability reason.
aName
- Label associated with resultaIsAvailable
- Is the label available to be created?aReason
- Reason that label is not availablepublic EPPNameVerificationCheckResult(java.lang.String aName, boolean aIsAvailable, java.lang.String aReason, java.lang.String aLanguage, boolean aRestricted)
EPPNameVerificationCheckResult
that includes
all attributes.
aName
- Label associated with resultaIsAvailable
- Is the label available to be created?aReason
- Reason that label is not availableaLanguage
- Language of the aReason
value.aRestricted
- Is the label restricted?Method Detail |
---|
public java.lang.String getLabel()
null
otherwise.public void setLabel(java.lang.String aLabel)
aLabel
- Label associated with the result.public boolean isAvailable()
EPPNameVerificationCheckResult
is availability to be
created.
false
, call
getReason()
for the unavailable reason.public void setIsAvailable(boolean aIsAvailable)
EPPNameVerificationCheckResult
is availability to be
created.
aIsAvailable
- Is the label available to be created?public void setReason(java.lang.String aReason)
aReason
- OPTIONAL reason value.public java.lang.String getReason()
public void setLanguage(java.lang.String aLanguage)
aLanguage
- Sets the reason language attribute.public java.lang.String getLanguage()
public boolean isRestricted()
true
if the label is restricted; false
otherwise.public void setRestricted(boolean aRestricted)
aRestricted
- true
if the label is restricted;
false
otherwise.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPNameVerificationCheckResult
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.
EPPNameVerificationCheckResult
instance.
EPPEncodeException
- Unable to encode
EPPNameVerificationCheckResult
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPNameVerificationCheckResult
attributes from
the aElement DOM Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode
EPPNameVerificationCheckResult
from.
EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPNameVerificationCheckResult
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
EPPNameVerificationCheckResult
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPNameVerificationCheckResult
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 |