Class EPPRelatedDomainExtFields

java.lang.Object
com.verisign.epp.codec.relateddomainext.EPPRelatedDomainExtFields
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable

public class EPPRelatedDomainExtFields extends Object implements EPPCodecComponent
EPPCodecComponent that encodes and decodes a <relDom:fieldsgt; tag

Title: EPP 1.0 Related Domain - fields tag

Description: The EPPRelatedDomainExtFields object represents the collection of fields that must be synchronized across all the related domains in the family. related domains. As such it is composed of a collection of EPPRelatedDomainExtField objects.
As XML, it is represented by a <relDom:fieldsgt; element containing a number of <relDom:fieldgt; elements.

See Also:
  • Field Details

  • Constructor Details

    • EPPRelatedDomainExtFields

      public EPPRelatedDomainExtFields()
      Default constructor
    • EPPRelatedDomainExtFields

      public EPPRelatedDomainExtFields(boolean aInSync)
      Constructor that takes the required inSync attribute value.
      Parameters:
      aInSync - Are the fields in sync?
    • EPPRelatedDomainExtFields

      public EPPRelatedDomainExtFields(List<EPPRelatedDomainExtField> aFields, boolean aInSync)
      Constructor that takes both attributes of the EPPRelatedDomainExtFields class including the inSync attribute and the fields attribute.
      Parameters:
      aFields - List of fields, represented with the EPPRelatedDomainExtField.
      aInSync - Are the fields in sync?
  • Method Details

    • clone

      public Object clone() throws CloneNotSupportedException
      A deep clone of the EPPRelatedDomainExtFields.
      Specified by:
      clone in interface EPPCodecComponent
      Overrides:
      clone in class Object
      Returns:
      clone of concrete EPPCodecComponent
      Throws:
      CloneNotSupportedException - standard Object.clone exception
      See Also:
    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Populate the data of this instance with the data stored in the given Element of the DOM tree
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - The root element of the report fragment of XML
      Throws:
      EPPDecodeException - Thrown if any errors occur during decoding.
    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Append all data from this EPPRelatedDomainExtFields to the given DOM Document
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - The DOM Document to append data to
      Returns:
      Encoded DOM Element
      Throws:
      EPPEncodeException - Thrown when errors occur during the encode attempt or if the instance is invalid.
    • equals

      public boolean equals(Object aObj)
      A deep comparison of this with another EPPRelatedDomainExtFields.
      Overrides:
      equals in class Object
      See Also:
    • addField

      public void addField(EPPRelatedDomainExtField aField)
      Adds a field represented by EPPRelatedDomainExtField to the list of fields.
      Parameters:
      aField - Field to add to the list.
    • hasFields

      public boolean hasFields()
      Are there any fields included in the list of fields?
      Returns:
      true if the field list is not null and there is at least one field in the list; false otherwise.
    • getFields

      public List<EPPRelatedDomainExtField> getFields()
      Returns the fields
      Returns:
      the fields
    • setFields

      public void setFields(List<EPPRelatedDomainExtField> fields)
      Sets fields value to fields
      Parameters:
      fields - the fields to set
    • isInSync

      public boolean isInSync()
      Returns the inSync
      Returns:
      the inSync
    • setInSync

      public void setInSync(boolean aInSync)
      Sets inSync value to aInSync
      Parameters:
      aInSync - the inSync to set
    • 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.