Class EPPRelatedDomainExtTransfer
- java.lang.Object
-
- com.verisign.epp.codec.relateddomainext.EPPRelatedDomainExtTransfer
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPRelatedDomainExtTransfer extends java.lang.Object implements EPPCodecComponent
EPPCodecComponent that encodes and decodes a <relDom:transfer> tag associated with a Domain-Transfer command.Title: EPP 1.0 Related Domain - Transfer tag
Description: The EPPRelatedDomainExtTransfer object represents the collection of domains that must be transfered atomically. As such it is composed of a collection of
EPPRelatedDomainExtDomain
objects.
As XML, it is represented by a <relDom:transfer> element containing a number of <relDom:domain> elements.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_NAME
Element tag name for Transfer
-
Constructor Summary
Constructors Constructor Description EPPRelatedDomainExtTransfer()
Default constructorEPPRelatedDomainExtTransfer(java.util.List<EPPRelatedDomainExtDomain> aDomains)
Constructor with a list of domains to be transferred.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDomain(EPPRelatedDomainExtDomain aDomain)
Adds a related domain represented byEPPRelatedDomainExtDomain
to the list of related domains to transfer.java.lang.Object
clone()
A deep clone of the EPPRelatedDomainExtTransfervoid
decode(org.w3c.dom.Element aElement)
Populate the data of this instance with the data stored in the given Element of the DOM treeorg.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
Append all data from the list of the list of transfer related domains represented byEPPRelatedDomainExtDomain
to given DOM Documentboolean
equals(java.lang.Object aObj)
A deep comparison of this with another EPPRelatedDomainExtTransfer.java.util.List<EPPRelatedDomainExtDomain>
getDomains()
Returns the list of Transfer related domain names represented byEPPRelatedDomainExtName
java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.boolean
hasDomains()
Are there any domains included in the list of domains?void
setDomains(java.util.List<EPPRelatedDomainExtDomain> aDomains)
Sets the list of transfer related domain names represented byEPPRelatedDomainExtDomain
java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_NAME
public static final java.lang.String ELM_NAME
Element tag name for Transfer- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPRelatedDomainExtTransfer
public EPPRelatedDomainExtTransfer()
Default constructor
-
EPPRelatedDomainExtTransfer
public EPPRelatedDomainExtTransfer(java.util.List<EPPRelatedDomainExtDomain> aDomains)
Constructor with a list of domains to be transferred.- Parameters:
aDomains
- Domains to be transferred
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
A deep clone of the EPPRelatedDomainExtTransfer- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of concrete
EPPCodecComponent
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception- See Also:
Object.clone()
-
decode
public void decode(org.w3c.dom.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 interfaceEPPCodecComponent
- Parameters:
aElement
- The root element of the report fragment of XML- Throws:
EPPDecodeException
- Thrown if any errors occur during decoding.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Append all data from the list of the list of transfer related domains represented byEPPRelatedDomainExtDomain
to given DOM Document- Specified by:
encode
in 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
public boolean equals(java.lang.Object aObj)
A deep comparison of this with another EPPRelatedDomainExtTransfer.- Overrides:
equals
in classjava.lang.Object
- See Also:
Object.equals(java.lang.Object)
-
addDomain
public void addDomain(EPPRelatedDomainExtDomain aDomain)
Adds a related domain represented byEPPRelatedDomainExtDomain
to the list of related domains to transfer.- Parameters:
aDomain
- Related domain to add to the list to transfer.
-
hasDomains
public boolean hasDomains()
Are there any domains included in the list of domains?- Returns:
true
if the domain list is notnull
and there is at least one domain in the list;false
otherwise.
-
getDomains
public java.util.List<EPPRelatedDomainExtDomain> getDomains()
Returns the list of Transfer related domain names represented byEPPRelatedDomainExtName
- Returns:
- the related domains to transfer
-
setDomains
public void setDomains(java.util.List<EPPRelatedDomainExtDomain> aDomains)
Sets the list of transfer related domain names represented byEPPRelatedDomainExtDomain
- Parameters:
aDomains
- the related domains to transfer
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-