Package com.verisign.epp.codec.launch

Class EPPLaunchCheckResult

java.lang.Object
com.verisign.epp.codec.launch.EPPLaunchCheckResult
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPLaunchCheckResult extends Object implements EPPCodecComponent
The 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.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    Constant for the claims check result local name
    static final String
    ELM_NAME
    Constant for the claims check result tag

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPLaunchCheckResult()
    Default constructor for EPPLaunchCheckResult.
    EPPLaunchCheckResult(String aName, boolean aExists)
    Create a EPPLaunchCheckResult with the required attributes of name and exists.
    EPPLaunchCheckResult(String aName, boolean aExists, String aClaimKey)
    Create a EPPLaunchCheckResult with the required attributes of name and exists, and the optional claimKey attribute.
    EPPLaunchCheckResult(String aName, boolean aExists, String aClaimKey, String aValidatorId)
    Create a EPPLaunchCheckResult with the required attributes of name and exists, and the optional claimKey attribute.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addClaimKey(EPPLaunchClaimKey aClaimKey)
    Adds a claims key to the list of claim keys.
    void
    addClaimKey(String aClaimKey)
    Adds a claims key to the list of claim keys with a specified validator.
    void
    addClaimKey(String aClaimKey, String aValidatorIdentifier)
    Adds a claims key to the list of claim keys with specified Validator Identifier.
    void
    clearClaimKeys()
    Clear the claim keys set.
    Object
    clone()
    Clone EPPLaunchCheckResult.
    void
    decode(Element aElement)
    Decode the EPPLaunchCheckResult attributes from the aElement DOM Element tree.
    Element
    encode(Document aDocument)
    Encode a DOM Element tree from the attributes of the EPPLaunchCheckResult instance.
    boolean
    equals(Object aObject)
    implements a deep EPPLaunchCheckResult compare.
    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.
    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.
    String
    getName()
    Gets the domain name associated with the result.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    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(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(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(String aName)
    Sets the domain name associated with the result.
    void
    setValidatorId(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.
    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 Details

  • Constructor Details

    • EPPLaunchCheckResult

      public EPPLaunchCheckResult()
      Default constructor for EPPLaunchCheckResult.

    • EPPLaunchCheckResult

      public EPPLaunchCheckResult(String aName, boolean aExists)
      Create a EPPLaunchCheckResult with the required attributes of name and exists.
      Parameters:
      aName - Domain name of result
      aExists - true if there is a matching trademark for the domain name; false otherwise.

    • EPPLaunchCheckResult

      public EPPLaunchCheckResult(String aName, boolean aExists, String aClaimKey)
      Create a EPPLaunchCheckResult with the required attributes of name and exists, and the optional claimKey attribute.
      Parameters:
      aName - Domain name of result
      aExists - 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.

    • EPPLaunchCheckResult

      public EPPLaunchCheckResult(String aName, boolean aExists, String aClaimKey, String aValidatorId)
      Create a EPPLaunchCheckResult with the required attributes of name and exists, and the optional claimKey attribute.
      Parameters:
      aName - Domain name of result
      aExists - 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.

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPLaunchCheckResult instance.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPLaunchCheckResult instance.
      Throws:
      EPPEncodeException - Unable to encode EPPLaunchCheckResult instance.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the EPPLaunchCheckResult attributes from the aElement DOM Element tree.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Root DOM Element to decode EPPLaunchCheckResult from.
      Throws:
      EPPDecodeException - Unable to decode aElement.

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPLaunchCheckResult compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPLaunchCheckResult instance to compare with
      Returns:
      true if equal false otherwise

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPLaunchCheckResult.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPLaunchCheckResult
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • getName

      public String getName()
      Gets the domain name associated with the result.
      Returns:
      Domain name associated with the result if defined; null otherwise.

    • setName

      public void setName(String aName)
      Sets the domain name associated with the result.
      Parameters:
      aName - Domain Name associated with the result.

    • isExists

      public boolean isExists()
      Gets whether a trademark exist that matches the domain name?
      Returns:
      true if there is a matching trademark for the domain name; false otherwise.

    • setExists

      public void setExists(boolean aExists)
      Sets whether a trademark exist that matches the domain name?
      Parameters:
      aExists - true if there is a matching trademark for the domain name; false otherwise.

    • getClaimKey

      public 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.
      Returns:
      Claim key if at least one key is set; null otherwise.

    • clearClaimKeys

      public void clearClaimKeys()
      Clear the claim keys set. The result will be an empty claim keys list.

    • setClaimKey

      public void setClaimKey(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.
      Parameters:
      aClaimKey - Claim key

    • getClaimKeys

      public 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.
      Returns:
      Claim key if set; null otherwise.

    • setClaimKeys

      public void setClaimKeys(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.
      Parameters:
      aClaimKeys - List of claim keys

    • addClaimKey

      public void addClaimKey(EPPLaunchClaimKey aClaimKey)
      Adds a claims key to the list of claim keys.
      Parameters:
      aClaimKey - Claim key to add

    • addClaimKey

      public void addClaimKey(String aClaimKey)
      Adds a claims key to the list of claim keys with a specified validator.
      Parameters:
      aClaimKey - Claim key to add with no specified validatorId

    • addClaimKey

      public void addClaimKey(String aClaimKey, String aValidatorIdentifier)
      Adds a claims key to the list of claim keys with specified Validator Identifier.
      Parameters:
      aClaimKey - Claim key to add with no specified Validator Identifier
      aValidatorIdentifier - Validator Identifier, where null or a value of "tmch" can be specified to indicate the use of the ICANN TMCH.

    • getValidatorId

      public 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. If undefined, the ICANN TMCH is the Validator or if the value is "tmch".
      Returns:
      The Validator Identifier if defined; null otherwise to indicate to use the ICANN TMCH.

    • setValidatorId

      public void setValidatorId(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. A null value or a value of "tmch" can be specified to indicate the use of the ICANN TMCH.
      Parameters:
      aValidatorId - Validator Identifier, where null or a value of "tmch" can be specified to indicate the use of the ICANN TMCH.

    • hasValidatorId

      public boolean hasValidatorId()
      Is the Validator Identifier defined?
      Returns:
      true if the Validator Identifier is defined; false otherwise.

    • toString

      public String toString()
      Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
      Overrides:
      toString in class Object
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.