Package com.verisign.epp.codec.org

Class EPPOrgRole

java.lang.Object
com.verisign.epp.codec.org.EPPOrgRole
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPOrgRole extends Object implements EPPCodecComponent
EPPOrgRole contains the role type and optional role id of the organization.
See Also:

  • Field Details

  • Constructor Details

    • EPPOrgRole

      public EPPOrgRole()
      Default constructor for EPPOrgRole.

    • EPPOrgRole

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

    • EPPOrgRole

      public EPPOrgRole(String aRole, 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(String aRole, EPPOrgRoleStatus aStatus, 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(String aRole, List<EPPOrgRoleStatus> aStatuses, 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 Details

    • getType

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

    • setType

      public void setType(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 List<EPPOrgRoleStatus> getStatuses()
      Gets the role statuses of the role.
      Returns:
      List of role statuses of the role.

    • setStatuses

      public void setStatuses(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 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(String aRoleId)
      Sets the OPTIONAL organization role identifier such as IANA ID for registrars..
      Parameters:
      aRoleId - The organization identifier

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

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