Package com.verisign.epp.codec.validate.v02

Class EPPValidateCheckResult

java.lang.Object
com.verisign.epp.codec.validate.v02.EPPValidateCheckResult
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPValidateCheckResult extends Object implements EPPCodecComponent
EPPValidateCheckResult represents the result of an individual contact validation. The attributes of EPPValidateCheckResult include the contact identifier, the result code, and zero or more key value pairs.
See Also:

  • Field Details

  • Constructor Details

    • EPPValidateCheckResult

      public EPPValidateCheckResult()
      Default constructor for EPPValidateCheckResult.

    • EPPValidateCheckResult

      public EPPValidateCheckResult(String aId, int aCode)
      Constructor for EPPValidateCheckResult that includes the required attributes of the contact identifier and the result code.
      Parameters:
      aId - Contact identifier
      aCode - Must be one of the EPPResult result code constant values.

  • Method Details

    • getId

      public String getId()
      Gets the contact identifier.
      Returns:
      The contact identifier if defined;null otherwise.

    • setId

      public void setId(String aId)
      Sets the contact identifier.
      Parameters:
      aId - The contact identifier

    • getCode

      public int getCode()
      Gets the result code.
      Returns:
      Must be one of the EPPResult result code constant values if defined; -1 otherwise.

    • setCode

      public void setCode(int aCode)
      Sets the result code.
      Parameters:
      aCode - Must be one of the EPPResult result code constant values.

    • addKeyValue

      public void addKeyValue(EPPValidateKeyValue aKeyValue)
      Adds a key value pair to the list of key value pairs. The key value pair is used to defined specific validation errors.
      Parameters:
      aKeyValue - Key value pair to add to the list

    • setKeyValues

      public void setKeyValues(List<EPPValidateKeyValue> aKeyValues)
      Sets the full list of key value pairs. A key value pair is used to define specific validation errors.
      Parameters:
      aKeyValues - List of EPPValidateKeyValue instances.

    • getKeyValues

      public List<EPPValidateKeyValue> getKeyValues()
      Gets the full list of key value pairs. A key value pair is used to define specific validation errors.
      Returns:
      List of EPPValidateKeyValue instances.

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPValidateCheckResult 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 EPPValidateCheckResult instance.
      Throws:
      EPPEncodeException - Unable to encode EPPValidateCheckResult instance.

    • decode

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPValidateCheckResult with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPValidateCheckResult.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPValidateCheckResult
      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 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.