Package com.verisign.epp.codec.orgext

Class EPPOrgExtId

java.lang.Object
com.verisign.epp.codec.orgext.EPPOrgExtId
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPOrgExtId extends Object implements EPPCodecComponent
EPPOrgExtId is used to define an organization identifier with a required role. The organization identifier can be empty in the case of a delete.
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELM_LOCALNAME
    XML local name for EPPOrgExtId.
    static final String
    ELM_NAME
    XML root tag for EPPOrgExtId.

  • Constructor Summary

    Constructors
    Constructor
    Description
    EPPOrgExtId()
    Default constructor for EPPOrgExtId.
    EPPOrgExtId(String aRole)
    Constructor for EPPOrgExtId that takes the role.
    EPPOrgExtId(String aRole, String aOrgId)
    Constructor for EPPOrgExtId that takes the role and the organization identifier value.

  • Method Summary

    Modifier and Type
    Method
    Description
    Object
    clone()
    clone an EPPCodecComponent.
    void
    decode(Element aElement)
    decode a DOM element tree to initialize the instance attributes.
    Element
    encode(Document aDocument)
    encode instance into a DOM element tree.
    boolean
    equals(Object aObject)
    Compare an instance of EPPOrgExt with this instance.
    String
    getNamespace()
    Returns the XML namespace associated with the EPPCodecComponent.
    String
    getOrgId()
    Gets the organization identifier.
    String
    getRole()
    Gets the organization role.
    boolean
    hasOrgId()
    Is the organization identifier defined?
    void
    setOrgId(String aOrgId)
    Sets the organization identifier.
    void
    setRole(String aRole)
    Sets the organization role.
    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 Details

  • Constructor Details

    • EPPOrgExtId

      public EPPOrgExtId()
      Default constructor for EPPOrgExtId.

    • EPPOrgExtId

      public EPPOrgExtId(String aRole)
      Constructor for EPPOrgExtId that takes the role.
      Parameters:
      aRole - Organization role

    • EPPOrgExtId

      public EPPOrgExtId(String aRole, String aOrgId)
      Constructor for EPPOrgExtId that takes the role and the organization identifier value.
      Parameters:
      aRole - Organization role
      aOrgId - Organization identifier

  • Method Details

    • hasOrgId

      public boolean hasOrgId()
      Is the organization identifier defined?
      Returns:
      true if the organization identifier is defined; false otherwise.

    • getOrgId

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

    • setOrgId

      public void setOrgId(String aOrgId)
      Sets the organization identifier.
      Parameters:
      aOrgId - The organization identifier

    • getRole

      public String getRole()
      Gets the organization role.
      Returns:
      The organization role if defined;null otherwise.

    • setRole

      public void setRole(String aRole)
      Sets the organization role.
      Parameters:
      aRole - The organization role

    • encode

      public Element encode(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 EPPOrgExtId

    • decode

      public void decode(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 Object clone() throws CloneNotSupportedException
      clone an EPPCodecComponent.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPOrgExt
      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.

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPOrgExt with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false 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.