Class EPPRelatedDomainExtFields
java.lang.Object
com.verisign.epp.codec.relateddomainext.EPPRelatedDomainExtFields
- All Implemented Interfaces:
EPPCodecComponent,Serializable,Cloneable
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 Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionDefault constructorEPPRelatedDomainExtFields(boolean aInSync) Constructor that takes the requiredinSyncattribute value.EPPRelatedDomainExtFields(List<EPPRelatedDomainExtField> aFields, boolean aInSync) Constructor that takes both attributes of theEPPRelatedDomainExtFieldsclass including theinSyncattribute and thefieldsattribute. -
Method Summary
Modifier and TypeMethodDescriptionvoidaddField(EPPRelatedDomainExtField aField) Adds a field represented byEPPRelatedDomainExtFieldto the list of fields.clone()A deep clone of the EPPRelatedDomainExtFields.voidPopulate the data of this instance with the data stored in the given Element of the DOM treeAppend all data from this EPPRelatedDomainExtFields to the given DOM DocumentbooleanA deep comparison of this with another EPPRelatedDomainExtFields.Returns the fieldsReturns the XML namespace associated with theEPPCodecComponent.booleanAre there any fields included in the list of fields?booleanisInSync()Returns the inSyncvoidsetFields(List<EPPRelatedDomainExtField> fields) Sets fields value to fieldsvoidsetInSync(boolean aInSync) Sets inSync value to aInSynctoString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.
-
Field Details
-
ELM_NAME
Element tag name for the fields- See Also:
-
-
Constructor Details
-
EPPRelatedDomainExtFields
public EPPRelatedDomainExtFields()Default constructor -
EPPRelatedDomainExtFields
public EPPRelatedDomainExtFields(boolean aInSync) Constructor that takes the requiredinSyncattribute value.- Parameters:
aInSync- Are the fields in sync?
-
EPPRelatedDomainExtFields
Constructor that takes both attributes of theEPPRelatedDomainExtFieldsclass including theinSyncattribute and thefieldsattribute.- Parameters:
aFields- List of fields, represented with theEPPRelatedDomainExtField.aInSync- Are the fields in sync?
-
-
Method Details
-
clone
A deep clone of the EPPRelatedDomainExtFields.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classObject- Returns:
- clone of concrete
EPPCodecComponent - Throws:
CloneNotSupportedException- standard Object.clone exception- See Also:
-
decode
Populate the data of this instance with the data stored in the given Element of the DOM tree- Specified by:
decodein interfaceEPPCodecComponent- Parameters:
aElement- The root element of the report fragment of XML- Throws:
EPPDecodeException- Thrown if any errors occur during decoding.
-
encode
Append all data from this EPPRelatedDomainExtFields to the given DOM Document- Specified by:
encodein interfaceEPPCodecComponent- 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
A deep comparison of this with another EPPRelatedDomainExtFields. -
hasFields
public boolean hasFields()Are there any fields included in the list of fields?- Returns:
trueif the field list is notnulland there is at least one field in the list;falseotherwise.
-
getFields
Returns the fields- Returns:
- the fields
-
setFields
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
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent. -
getNamespace
Returns the XML namespace associated with theEPPCodecComponent.- Specified by:
getNamespacein interfaceEPPCodecComponent- Returns:
- XML namespace for the
EPPCodecComponent.
-