Package com.verisign.epp.codec.org

Class EPPOrgCheckCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPCheckCmd
com.verisign.epp.codec.org.EPPOrgCheckCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPOrgCheckCmd extends EPPCheckCmd
Represents a org <check> command that enables checking on the availability of a set of client-specified but server-unique org identifiers.
See Also:

  • Field Details

  • Constructor Details

    • EPPOrgCheckCmd

      public EPPOrgCheckCmd()
      EPPOrgCheckCmd default constructor.

    • EPPOrgCheckCmd

      public EPPOrgCheckCmd(String aTransId)
      EPPOrgCheckCmd constructor that only takes the client transaction identifier
      Parameters:
      aTransId - Transaction Id associated with command.

    • EPPOrgCheckCmd

      public EPPOrgCheckCmd(String aTransId, String aOrgId)
      EPPOrgCheckCmd constructor for setting an individual org identifier to check.
      Parameters:
      aTransId - Transaction Id associated with command.
      aOrgId - Org identifier to check

    • EPPOrgCheckCmd

      public EPPOrgCheckCmd(String aTransId, List<String> aOrgIds)
      EPPOrgCheckCmd constructor for setting the list of org identifiers to check.
      Parameters:
      aTransId - Transaction Id associated with command.
      aOrgIds - List of Org identifiers to check

  • Method Details

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPOrgCheckCmd .
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPOrgMapFactory.NS

    • getKey

      public String getKey()
      Gets the key for the organization object, which is the organization identifier.
      Overrides:
      getKey in class EPPCommand
      Returns:
      The organization identifier if set with a single value; null otherwise.

    • hasOrgIds

      public boolean hasOrgIds()
      Are any org identifiers defined in the list of org identifiers?
      Returns:
      true if there is at least one org identifier defined; false otherwise.

    • getOrgIds

      public List<String> getOrgIds()
      Get the list of org identifiers to check.
      Returns:
      List of org identifier String's

    • setOrgIds

      public void setOrgIds(List<String> aOrgIds)
      Set the list of org identifiers to check.
      Parameters:
      aOrgIds - List of org identifier String's

    • setOrgId

      public void setOrgId(String aOrgId)
      Set an individual org identifier to check. This method clears the existing list of org identifiers.
      Parameters:
      aOrgId - Org identifier to check

    • addOrgId

      public void addOrgId(String aOrgId)
      Append a org identifier to the list of org identifiers to check. This method does NOT clear the existing list of org identifiers.
      Parameters:
      aOrgId - Org identifier to check

    • doEncode

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

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPOrgCheckCmd attributes from the aElement DOM Element tree.
      Specified by:
      doDecode in class EPPCheckCmd
      Parameters:
      aElement - Root DOM Element to decode EPPOrgCheckCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPOrgCheckCmd with this instance.
      Overrides:
      equals in class EPPCheckCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if this object is the same as the aObject argument; false otherwise.

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPOrgCheckCmd.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class EPPCommand
      Returns:
      Deep copy clone of EPPOrgCheckCmd
      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 EPPCommand
      Returns:
      Indented XML String if successful; ERROR otherwise.