Package com.verisign.epp.codec.org

Class EPPOrgRole

  • All Implemented Interfaces:
    EPPCodecComponent, java.io.Serializable, java.lang.Cloneable
    public class EPPOrgRole
extends java.lang.Object
implements EPPCodecComponent
    EPPOrgRole contains the role type and optional role id of the organization.
    See Also:
    Serialized Form

    • Field Summary

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

    • Constructor Summary

      Constructors 
      Constructor Description
      EPPOrgRole()
      Default constructor for EPPOrgRole.
      EPPOrgRole​(java.lang.String aType)
      Constructor for EPPOrgRole that takes the role type.
      EPPOrgRole​(java.lang.String aRole, EPPOrgRoleStatus aStatus, java.lang.String aRoleId)
      Constructor for EPPOrgRole that takes the role, a single status, and a role identifier.
      EPPOrgRole​(java.lang.String aRole, java.util.List<EPPOrgRoleStatus> aStatuses)
      Constructor for EPPOrgRole that takes the role with a list of statuses.
      EPPOrgRole​(java.lang.String aRole, java.util.List<EPPOrgRoleStatus> aStatuses, java.lang.String aRoleId)
      Constructor for EPPOrgRole that takes the role, a list of statuses, and a role identifier.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addStatus​(EPPOrgRoleStatus aStatus)
      Add a role status to list of role statuses.
      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 gerRoleId()
      Gets the OPTIONAL organization role identifier such as IANA ID for registrars..
      java.lang.String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      java.util.List<EPPOrgRoleStatus> getStatuses()
      Gets the role statuses of the role.
      java.lang.String getType()
      Gets the organization role type.
      boolean hasRoleId()
      Is the organization role identifier defined?
      boolean hasStatus()
      Is there at least one status?
      void setRoleId​(java.lang.String aRoleId)
      Sets the OPTIONAL organization role identifier such as IANA ID for registrars..
      void setStatuses​(java.util.List<EPPOrgRoleStatus> aStatuses)
      Sets the role statuses of the role.
      void setType​(java.lang.String aType)
      Sets the organization role type.
      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 EPPOrgRole.
        See Also:
        Constant Field Values

      • ELM_NAME

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

    • Constructor Detail

      • EPPOrgRole

        public EPPOrgRole()
        Default constructor for EPPOrgRole.

      • EPPOrgRole

        public EPPOrgRole​(java.lang.String aType)
        Constructor for EPPOrgRole that takes the role type.
        Parameters:
        aType - Organization role type

      • EPPOrgRole

        public EPPOrgRole​(java.lang.String aRole,
                  java.util.List<EPPOrgRoleStatus> aStatuses)
        Constructor for EPPOrgRole that takes the role with a list of statuses.
        Parameters:
        aRole - Organization role
        aStatuses - Organization role statuses

      • EPPOrgRole

        public EPPOrgRole​(java.lang.String aRole,
                  EPPOrgRoleStatus aStatus,
                  java.lang.String aRoleId)
        Constructor for EPPOrgRole that takes the role, a single status, and a role identifier.
        Parameters:
        aRole - Organization role
        aStatus - Single organization role statuses
        aRoleId - Role identifier

      • EPPOrgRole

        public EPPOrgRole​(java.lang.String aRole,
                  java.util.List<EPPOrgRoleStatus> aStatuses,
                  java.lang.String aRoleId)
        Constructor for EPPOrgRole that takes the role, a list of statuses, and a role identifier.
        Parameters:
        aRole - Organization role
        aStatuses - Organization role statuses
        aRoleId - Role identifier

    • Method Detail

      • getType

        public java.lang.String getType()
        Gets the organization role type.
        Returns:
        The organization role type if defined;null otherwise.

      • setType

        public void setType​(java.lang.String aType)
        Sets the organization role type.
        Parameters:
        aType - The organization role type

      • hasStatus

        public boolean hasStatus()
        Is there at least one status?
        Returns:
        true if there at least one status; false otherwise.

      • getStatuses

        public java.util.List<EPPOrgRoleStatus> getStatuses()
        Gets the role statuses of the role.
        Returns:
        List of role statuses of the role.

      • setStatuses

        public void setStatuses​(java.util.List<EPPOrgRoleStatus> aStatuses)
        Sets the role statuses of the role.
        Parameters:
        aStatuses - Role statuses

      • addStatus

        public void addStatus​(EPPOrgRoleStatus aStatus)
        Add a role status to list of role statuses.
        Parameters:
        aStatus - Role status to add.

      • hasRoleId

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

      • gerRoleId

        public java.lang.String gerRoleId()
        Gets the OPTIONAL organization role identifier such as IANA ID for registrars..
        Returns:
        The organization role identifier if defined;null otherwise.

      • setRoleId

        public void setRoleId​(java.lang.String aRoleId)
        Sets the OPTIONAL organization role identifier such as IANA ID for registrars..
        Parameters:
        aRoleId - The organization identifier

      • 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 EPPOrgRole

      • 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.