Package com.verisign.epp.codec.registry

Class EPPRegistryRelated

java.lang.Object
com.verisign.epp.codec.registry.EPPRegistryRelated
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPRegistryRelated extends Object implements EPPCodecComponent
Class to hold the related zone information that include the list of related zone members and an optional definition of the fields that are shared or that are required to be synchronized.
See Also:

  • Field Details

  • Constructor Details

    • EPPRegistryRelated

      public EPPRegistryRelated()
      Default constructor with an empty list of related zone members.

    • EPPRegistryRelated

      public EPPRegistryRelated(List<EPPRegistryZoneMember> aMembers)
      Constructor for EPPRegistryRelated that takes the required members field.
      Parameters:
      aMembers - Zone members list.

    • EPPRegistryRelated

      public EPPRegistryRelated(List<EPPRegistryZoneMember> aMembers, EPPRegistryFields aFields)
      Constructor for EPPRegistryRelated that takes the required members field and the optional fields field.
      Parameters:
      aMembers - Zone members list.
      aFields - Definition of how the related zone fields are managed.

  • Method Details

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode the EPPRegistryRelated to a DOM Element
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - a DOM Document to attach data to.
      Returns:
      The root element of this component.
      Throws:
      EPPEncodeException - Thrown if any errors prevent encoding.

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode the DOM element to the EPPRegistryRelated.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - DOM Element to decode the attribute values
      Throws:
      EPPDecodeException - Error decoding the DOM Element

    • clone

      public Object clone() throws CloneNotSupportedException
      Clone EPPRegistryRelated.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of EPPRegistryRelated
      Throws:
      CloneNotSupportedException - standard Object.clone exception

    • equals

      public boolean equals(Object aObject)
      implements a deep EPPRegistryRelated compare.
      Overrides:
      equals in class Object
      Parameters:
      aObject - EPPRegistryRelated instance to compare with
      Returns:
      true if equal false otherwise

    • getFields

      public EPPRegistryFields getFields()
      Gets the related fields definition.
      Returns:
      Related fields if defined; null otherwise.

    • setFields

      public void setFields(EPPRegistryFields aFields)
      Sets the related fields definition.
      Parameters:
      aFields - Related fields

    • hasFields

      public boolean hasFields()
      Are fields defined?
      Returns:
      true if fields are defined; false otherwise.

    • getMembers

      public List<EPPRegistryZoneMember> getMembers()
      Gets the related zone members.
      Returns:
      Related zone members if defined; null otherwise.

    • setMembers

      public void setMembers(List<EPPRegistryZoneMember> aMembers)
      Sets the related zone members.
      Parameters:
      aMembers - Related zone members

    • addMember

      public void addMember(EPPRegistryZoneMember aMember)
      Adds a zone member to the list of related zone members.
      Parameters:
      aMember - Zone member to add to the list of related zone members.

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

    • getNamespace

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