|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.launch.EPPLaunchClaimKey
public class EPPLaunchClaimKey
The EPPLaunchClaimKey
a claim key that MAY be passed to a
third-party trademark validator such as the Trademark Clearinghouse (TMCH)
for querying the information needed to generate a Trademark Claims Notice.
The claim key is used as the key for the query in place of the domain name to
securely query the service without using a well-known value like a domain
name. The OPTIONAL "validatorID" attribute is the Validator
Identifier whose value indicates which Trademark Validator to query for the
Claims Notice information, with the default being the ICANN TMCH. The
"validatorID" attribute MAY reference a non-trademark claims
clearinghouse identifier to support other forms of claims notices.
Field Summary | |
---|---|
static java.lang.String |
ELM_LOCALNAME
Constant for the claim key local name |
static java.lang.String |
ELM_NAME
Constant for the claims check result tag |
Constructor Summary | |
---|---|
EPPLaunchClaimKey()
Default constructor for EPPLaunchClaimKey . |
|
EPPLaunchClaimKey(java.lang.String aClaimKey)
Create a EPPLaunchClaimKey with the required attribute of of
claimKey . |
|
EPPLaunchClaimKey(java.lang.String aClaimKey,
java.lang.String aValidatorId)
Create a EPPLaunchClaimKey with the required attribute of
claimKey , and the optional validatorId
attribute. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPLaunchClaimKey . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPLaunchClaimKey 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 EPPLaunchClaimKey instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPLaunchClaimKey compare. |
java.lang.String |
getClaimKey()
Gets 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. |
java.lang.String |
getValidatorId()
Gets the OPTIONAL Validator Identifier, which is the unique identifier for the Trademark Validator to query for the Trademark Claims Notice information. |
boolean |
hasValidatorId()
Is the Validator Identifier defined? |
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 |
setValidatorId(java.lang.String aValidatorId)
Sets the OPTIONAL Validator Identifier, 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 . |
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 EPPLaunchClaimKey()
EPPLaunchClaimKey
.
public EPPLaunchClaimKey(java.lang.String aClaimKey)
EPPLaunchClaimKey
with the required attribute of of
claimKey
.
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 EPPLaunchClaimKey(java.lang.String aClaimKey, java.lang.String aValidatorId)
EPPLaunchClaimKey
with the required attribute of
claimKey
, and the optional validatorId
attribute.
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.Method Detail |
---|
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPLaunchClaimKey
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.
EPPLaunchClaimKey
instance.
EPPEncodeException
- Unable to encode EPPLaunchClaimKey
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPLaunchClaimKey
attributes from the aElement
DOM Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPLaunchClaimKey
from.
EPPDecodeException
- Unable to decode aElement.public boolean equals(java.lang.Object aObject)
EPPLaunchClaimKey
compare.
equals
in class java.lang.Object
aObject
- EPPLaunchClaimKey
instance to compare with
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPLaunchClaimKey
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPLaunchClaimKey
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String getClaimKey()
null
otherwise.public void setClaimKey(java.lang.String aClaimKey)
aClaimKey
- Claim keypublic 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.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |