Package com.verisign.epp.codec.orgext

Class EPPOrgExtInfData

  • All Implemented Interfaces:
    EPPCodecComponent, java.io.Serializable, java.lang.Cloneable
    public class EPPOrgExtInfData
extends java.lang.Object
implements EPPCodecComponent
    EPPOrgExtInfData is used in the extension to the info response to define the org identifiers.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELM_LOCALNAME
      XML local name for EPPOrgExtInfData.
      static java.lang.String ELM_NAME
      XML root tag for EPPOrgExtInfData.

    • Constructor Summary

      Constructors 
      Constructor Description
      EPPOrgExtInfData()
      Default constructor for EPPOrgExtInfData.
      EPPOrgExtInfData​(EPPOrgExtId aOrgId)
      Constructor for EPPOrgExtInfData that takes a single organization id.
      EPPOrgExtInfData​(java.util.List<EPPOrgExtId> aOrgIds)
      Constructor for EPPOrgExtInfData that takes a list of organization ids.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addOrgId​(EPPOrgExtId aOrgId)
      Add a organization id to the list of organization ids.
      java.lang.Object clone()
      clone an EPPCodecComponent.
      void decode​(org.w3c.dom.Element aElement)
      decode a DOM element tree to initialize the instance attributes.
      org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
      encode instance into a DOM element tree.
      boolean equals​(java.lang.Object aObject)
      Compare an instance of EPPOrgExt with this instance.
      java.lang.String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      java.util.List<EPPOrgExtId> getOrgIds()
      Returns the list of organization ids.
      boolean hasOrgIds()
      Are there any organization ids?
      void setOrgIds​(java.util.List<EPPOrgExtId> aOrgIds)
      Sets the organization ids.
      java.lang.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 Detail

      • ELM_LOCALNAME

        public static final java.lang.String ELM_LOCALNAME
        XML local name for EPPOrgExtInfData.
        See Also:
        Constant Field Values

      • ELM_NAME

        public static final java.lang.String ELM_NAME
        XML root tag for EPPOrgExtInfData.
        See Also:
        Constant Field Values

    • Constructor Detail

      • EPPOrgExtInfData

        public EPPOrgExtInfData()
        Default constructor for EPPOrgExtInfData.

      • EPPOrgExtInfData

        public EPPOrgExtInfData​(EPPOrgExtId aOrgId)
        Constructor for EPPOrgExtInfData that takes a single organization id.
        Parameters:
        aOrgId - Organization identifier

      • EPPOrgExtInfData

        public EPPOrgExtInfData​(java.util.List<EPPOrgExtId> aOrgIds)
        Constructor for EPPOrgExtInfData that takes a list of organization ids.
        Parameters:
        aOrgIds - Organization identifiers

    • Method Detail

      • hasOrgIds

        public boolean hasOrgIds()
        Are there any organization ids?
        Returns:
        true if there organization ids; false otherwise.

      • getOrgIds

        public java.util.List<EPPOrgExtId> getOrgIds()
        Returns the list of organization ids. An empty list indicates that there are no organization ids.
        Returns:
        List of organization ids.

      • setOrgIds

        public void setOrgIds​(java.util.List<EPPOrgExtId> aOrgIds)
        Sets the organization ids.
        Parameters:
        aOrgIds - The list of organization ids. Set to null or an empty list to indicate that there are no organization ids.

      • addOrgId

        public void addOrgId​(EPPOrgExtId aOrgId)
        Add a organization id to the list of organization ids.
        Parameters:
        aOrgId - organization id to add to the list of organization ids.

      • encode

        public org.w3c.dom.Element encode​(org.w3c.dom.Document aDocument)
                           throws EPPEncodeException
        encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
        Specified by:
        encode in interface EPPCodecComponent
        Parameters:
        aDocument - DOM Document, which acts is an Element factory
        Returns:
        Element Root element associated with the object
        Throws:
        EPPEncodeException - Error encoding EPPOrgExtInfData

      • decode

        public void decode​(org.w3c.dom.Element aElement)
            throws EPPDecodeException
        decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
        Specified by:
        decode in interface EPPCodecComponent
        Parameters:
        aElement - Element to decode
        Throws:
        EPPDecodeException - Error decoding Element

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        clone an EPPCodecComponent.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class java.lang.Object
        Returns:
        clone of concrete EPPOrgExt
        Throws:
        java.lang.CloneNotSupportedException - standard Object.clone exception

      • toString

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

      • equals

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

      • getNamespace

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