Package com.verisign.epp.codec.defReg

Class EPPDefRegCheckResp

java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.defReg.EPPDefRegCheckResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPDefRegCheckResp extends EPPResponse
Represents an EPPDefReg <defReg:chkData> response to a EPPDefRegFwdCheckCmd. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child defReg:chkData> element that identifies the defReg namespace. The <defReg:chkData> element contains one or more defReg:cd> elements that contain the following child elements:
  • A <defReg:name> element that contains the name of the queried defReg object. This element MUST contain an "avail" attribute whose value indicates object availability at the moment the <check> command was completed. A value of "1" or "true" means that the object is available. A value of "0" or "false" means that the object is not available. This element also MUST contain a "level" attribute whose value is either "premium" or "standard".
  • An OPTIONAL <defReg:reason> element that MAY be provided when an object is not available for provisioning. If present, this element contains server-specific text to help explain why the object is unavailable.
See Also:

  • Constructor Details

    • EPPDefRegCheckResp

      public EPPDefRegCheckResp()
      EPPDefRegFwdCheckResp default constructor. It will set results attribute to an empty Vector.

    • EPPDefRegCheckResp

      public EPPDefRegCheckResp(EPPTransId aTransId, EPPDefRegCheckResult aResult)
      EPPDefRegFwdCheckResp constructor that will set the result of an individual defReg.
      Parameters:
      aTransId - Transaction Id associated with response.
      aResult - EPPDefRegCheckResult results.

    • EPPDefRegCheckResp

      public EPPDefRegCheckResp(EPPTransId aTransId, Vector someResults)
      EPPDefRegFwdCheckResp constructor that will set the result of multiple defRegs.
      Parameters:
      aTransId - Transaction Id associated with response.
      someResults - Vector of EPPDefRegFwdCheckResult instances.

  • Method Details

    • getType

      public String getType()
      Get the EPP response type associated with EPPDefRegFwdCheckResp.
      Overrides:
      getType in class EPPResponse
      Returns:
      EPPDefRegFwdCheckResp.ELM_NAME

    • getNamespace

      public String getNamespace()
      Get the EPP command Namespace associated with EPPDefRegFwdCheckResp.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Overrides:
      getNamespace in class EPPResponse
      Returns:
      EPPDefRegFwdMapFactory.NS

    • equals

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

    • clone

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

    • 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 EPPResponse
      Returns:
      Indented XML String if successful; ERROR otherwise.

    • setCheckResults

      public void setCheckResults(Vector someResults)
      Set the results of a EPPDefRegFwdCheckResp Response. There is one EPPDefRegFwdCheckResult instance in someResults for each defReg requested in the EPPDefRegFwdCheckCmd Command.
      Parameters:
      someResults - Vector of EPPDefRegFwdCheckResult instances.

    • getCheckResults

      public Vector getCheckResults()
      Get the results of a EPPDefRegFwdCheckResp Response. There is one EPPDefRegFwdCheckResult instance in someResults for each defReg requested in the EPPDefRegFwdCheckResult Command.
      Returns:
      Vector of EPPDefRegFwdCheckResult instances.

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPDefRegFwdCheckResp instance.
      Overrides:
      doEncode in class EPPResponse
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPDefRegFwdCheckResp instance. defReg
      Throws:
      EPPEncodeException - Unable to encode EPPDefRegFwdCheckResp instance.

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPDefRegFwdCheckResp attributes from the aElement DOM Element tree.
      Overrides:
      doDecode in class EPPResponse
      Parameters:
      aElement - Root DOM Element to decode EPPDefRegFwdCheckResp from.
      Throws:
      EPPDecodeException - Unable to decode aElement