Package com.verisign.epp.codec.gen

Class EPPCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
Direct Known Subclasses:
EPPChangeCheckCmd, EPPContactCheckCmd, EPPDefRegCheckCmd, EPPDomainCheckCmd, EPPEmailFwdCheckCmd, EPPHostCheckCmd, EPPIdnTableCheckCmd, EPPNameVerificationCheckCmd, EPPOrgCheckCmd, EPPRegistryCheckCmd, EPPRegistryCheckCmd, EPPValidateCheckCmd
public abstract class EPPCheckCmd extends EPPCommand
The EPP check command is used to determine if an object exists in the server repository. The elements needed to identify an object are object-specific, so the child elements of the check command are specified using the EPP extension framework. In addition to the standard EPP command elements, the check command SHALL contain the following child elements: An object-specific "obj:check" element that identify the objects to be queried. Multiple objects of the same type MAY be queried within a single check command.

EPPCheckCmd is an abtract EPP command class that represents a check operation. A command mapping check command extends EPPCheckCmd. For example, EPPDomainCheckCmd is a EPPCheckCmd that implements the Domain Check Command Mapping.
See Also:

  • Constructor Details

    • EPPCheckCmd

      public EPPCheckCmd()
      Default constructor for EPPCheckCmd.

    • EPPCheckCmd

      public EPPCheckCmd(String aTransId)
      EPPCheckCmd that takes all required attributes as arguments. This will call the super EPPCommand(String) method to set the transaction id for the command.
      Parameters:
      aTransId - Transaction Id associated with command.

  • Method Details

    • getType

      public String getType()
      Gets the EPP command type associated with EPPCheckCmd.
      Specified by:
      getType in class EPPCommand
      Returns:
      EPPCommand.TYPE_CHECK

    • equals

      public boolean equals(Object aObject)
      Compares an instance of EPPCheckCmd with this instance.
      Overrides:
      equals in class EPPCommand
      Parameters:
      aObject - Object to compare with.
      Returns:
      DOCUMENT ME!

    • doGenEncode

      protected Element doGenEncode(Document aDocument) throws EPPEncodeException
      Encodes a DOM Element tree from the attributes of the EPPCheckCmd instance. This method is a member of the Template Design Pattern. EPPCommand.encode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Specified by:
      doGenEncode in class EPPCommand
      Parameters:
      aDocument - - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPCheckCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPCheckCmd instance.

    • doGenDecode

      protected void doGenDecode(Element aElement) throws EPPDecodeException
      Decodes the EPPCheckCmd attributes from the aElement DOM Element tree. This method is a member of the Template Design Pattern. EPPCommand.decode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Specified by:
      doGenDecode in class EPPCommand
      Parameters:
      aElement - - Root DOM Element to decode EPPCheckCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • doEncode

      protected abstract Element doEncode(Document aDocument) throws EPPEncodeException
      Must be defined by EPPCheckCmd extensions (Command Mappings) to encode the attributes to a DOM Element tree. doGenEncode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Parameters:
      aDocument - - DOM Document that is being built. Used as an Element factory.
      Returns:
      Root DOM Element representing the EPPCheckCmd extension instance.
      Throws:
      EPPEncodeException - Unable to encode EPPCheckCmd extension instance.

    • doDecode

      protected abstract void doDecode(Element aElement) throws EPPDecodeException
      Must be defined by EPPCheckCmd extensions (Command Mappings) to decode the attributes to a DOM Element tree. doGenDecode is a Template Method and this method is a Primitive Operation within the Template Method Design Pattern.
      Parameters:
      aElement - Root DOM Element representing the EPPCheckCmd extension instance.
      Throws:
      EPPDecodeException - Unable to decode aElement.