public class EPPLaunchCheckResult extends java.lang.Object implements EPPCodecComponent
EPPLaunchCheckResult
represents the claims check result for
an individual domain name. If there is a matching trademark for the domain
name, then the claims check result is indicated with exists
set
to true; otherwise set to false
. An OPTIONAL
claimKey
attribute MAY be used to query a third party trademark
provider like the Trademark Clearinghouse (TMCH) for getting the information
needed to generate the trademark claims notice.EPPLaunchChkData
,
Serialized FormModifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_LOCALNAME
Constant for the claims check result local name
|
static java.lang.String |
ELM_NAME
Constant for the claims check result tag
|
Constructor and Description |
---|
EPPLaunchCheckResult()
Default constructor for
EPPLaunchCheckResult . |
EPPLaunchCheckResult(java.lang.String aName,
boolean aExists)
Create a
EPPLaunchCheckResult with the required attributes
of name and exists . |
EPPLaunchCheckResult(java.lang.String aName,
boolean aExists,
java.lang.String aClaimKey)
Create a
EPPLaunchCheckResult with the required attributes
of name and exists , and the optional
claimKey attribute. |
EPPLaunchCheckResult(java.lang.String aName,
boolean aExists,
java.lang.String aClaimKey,
java.lang.String aValidatorId)
Create a
EPPLaunchCheckResult with the required attributes
of name and exists , and the optional
claimKey attribute. |
Modifier and Type | Method and Description |
---|---|
void |
addClaimKey(EPPLaunchClaimKey aClaimKey)
Adds a claims key to the list of claim keys.
|
void |
addClaimKey(java.lang.String aClaimKey)
Adds a claims key to the list of claim keys with a specified validator.
|
void |
addClaimKey(java.lang.String aClaimKey,
java.lang.String aValidatorIdentifier)
Adds a claims key to the list of claim keys with specified Validator
Identifier.
|
void |
clearClaimKeys()
Clear the claim keys set.
|
java.lang.Object |
clone()
Clone
EPPLaunchCheckResult . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPLaunchCheckResult 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
EPPLaunchCheckResult instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPLaunchCheckResult compare. |
java.lang.String |
getClaimKey()
Gets the first key in the claim keys that MAY be passed to an info
service of a third party trademark provider like the Trademark
Clearinghouse (TMCH) for getting the information needed to generate the
trademark claims notice.
|
java.util.List<EPPLaunchClaimKey> |
getClaimKeys()
Gets the claim keys that MAY be passed to info services of a third party
trademark provider like the Trademark Clearinghouse (TMCH) for getting
the information needed to generate the trademark claims notices.
|
java.lang.String |
getName()
Gets the domain name associated with the result.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.String |
getValidatorId()
Gets the OPTIONAL Validator Identifier for the first claims key, which is
the unique identifier for the Trademark Validator to query for the
Trademark Claims Notice information.
|
boolean |
hasValidatorId()
Is the Validator Identifier defined?
|
boolean |
isExists()
Gets whether a trademark exist that matches the domain name?
|
void |
setClaimKey(java.lang.String aClaimKey)
Sets the key that MAY be passed to an info service of a third party
trademark provider like the Trademark Clearinghouse (TMCH) for getting
the information needed to generate the trademark claims notice.
|
void |
setClaimKeys(java.util.List<EPPLaunchClaimKey> aClaimKeys)
Sets the claim keys that MAY be passed to info services of a third party
trademark provider like the Trademark Clearinghouse (TMCH) for getting
the information needed to generate the trademark claims notices.
|
void |
setExists(boolean aExists)
Sets whether a trademark exist that matches the domain name?
|
void |
setName(java.lang.String aName)
Sets the domain name associated with the result.
|
void |
setValidatorId(java.lang.String aValidatorId)
Sets the OPTIONAL Validator Identifier for the first claims key, which is
the unique identifier for the Trademark Validator to query for the
Trademark Claims Notice information.
|
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 EPPLaunchCheckResult()
EPPLaunchCheckResult
.public EPPLaunchCheckResult(java.lang.String aName, boolean aExists)
EPPLaunchCheckResult
with the required attributes
of name
and exists
.aName
- Domain name of resultaExists
- true
if there is a matching trademark for the
domain name; false
otherwise.public EPPLaunchCheckResult(java.lang.String aName, boolean aExists, java.lang.String aClaimKey)
EPPLaunchCheckResult
with the required attributes
of name
and exists
, and the optional
claimKey
attribute.aName
- Domain name of resultaExists
- true
if there is a matching trademark for the
domain name; false
otherwise.aClaimKey
- Key that MAY be passed to an info service of a third party
trademark provider like the Trademark Clearinghouse (TMCH) for
getting the information needed to generate the trademark
claims notice.public EPPLaunchCheckResult(java.lang.String aName, boolean aExists, java.lang.String aClaimKey, java.lang.String aValidatorId)
EPPLaunchCheckResult
with the required attributes
of name
and exists
, and the optional
claimKey
attribute.aName
- Domain name of resultaExists
- true
if there is a matching trademark for the
domain name; false
otherwise.aClaimKey
- Key that MAY be passed to an info service of a third party
trademark provider like the Trademark Clearinghouse (TMCH) for
getting the information needed to generate the trademark
claims notice.aValidatorId
- Identifier of the Trademark Validator to query using the
aClaimKey
value.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPLaunchCheckResult
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPLaunchCheckResult
instance.EPPEncodeException
- Unable to encode EPPLaunchCheckResult
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPLaunchCheckResult
attributes from the aElement
DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPLaunchCheckResult
from.EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPLaunchCheckResult
compare.equals
in class java.lang.Object
aObject
- EPPLaunchCheckResult
instance to compare withpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPLaunchCheckResult
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPLaunchCheckResult
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- Domain Name associated with the result.public boolean isExists()
true
if there is a matching trademark for the domain
name; false
otherwise.public void setExists(boolean aExists)
aExists
- true
if there is a matching trademark for the
domain name; false
otherwise.public java.lang.String getClaimKey()
null
otherwise.public void clearClaimKeys()
public void setClaimKey(java.lang.String aClaimKey)
aClaimKey
- Claim keypublic java.util.List<EPPLaunchClaimKey> getClaimKeys()
null
otherwise.public void setClaimKeys(java.util.List<EPPLaunchClaimKey> aClaimKeys)
aClaimKeys
- List of claim keyspublic void addClaimKey(EPPLaunchClaimKey aClaimKey)
aClaimKey
- Claim key to addpublic void addClaimKey(java.lang.String aClaimKey)
aClaimKey
- Claim key to add with no specified validatorIdpublic void addClaimKey(java.lang.String aClaimKey, java.lang.String aValidatorIdentifier)
aClaimKey
- Claim key to add with no specified Validator IdentifieraValidatorIdentifier
- Validator Identifier, where null
or a value of
"tmch" can be specified to indicate the use of the
ICANN TMCH.public java.lang.String getValidatorId()
null
otherwise
to indicate to use the ICANN TMCH.public void setValidatorId(java.lang.String aValidatorId)
null
value or a value
of "tmch" can be specified to indicate the use of the ICANN
TMCH.aValidatorId
- Validator Identifier, where null
or a value of
"tmch" can be specified to indicate the use of the
ICANN TMCH.public boolean hasValidatorId()
true
if the Validator Identifier is defined;
false
otherwise.public 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.