Class EPPRelatedDomainExtRenew
- java.lang.Object
-
- com.verisign.epp.codec.relateddomainext.EPPRelatedDomainExtRenew
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPRelatedDomainExtRenew extends java.lang.Object implements EPPCodecComponent
EPPCodecComponent that encodes and decodes a <relDom:renew> tag associated with a Domain-Renew command.Title: EPP 1.0 Related Domain - renew tag
Description: The EPPRelatedDomainExtRenew object represents the collection of domains that must be renewed atomically. As such it is composed of a collection of
EPPRelatedDomainExtDomain
objects.
As XML, it is represented by a <relDom:renew> 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 renew
-
Constructor Summary
Constructors Constructor Description EPPRelatedDomainExtRenew()
Default constructorEPPRelatedDomainExtRenew(java.util.List<EPPRelatedDomainExtDomain> aDomains)
Constructor with a list of domains to be renewed.
-
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 renew.java.lang.Object
clone()
A deep clone of the EPPRelatedDomainExtRenewvoid
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 available related domain names represented byEPPRelatedDomainExtDomain
to given DOM Documentboolean
equals(java.lang.Object aObj)
A deep comparison of this with another EPPRelatedDomainExtRenew.java.util.List<EPPRelatedDomainExtDomain>
getDomains()
Returns the list of available related domain names represented byEPPRelatedDomainExtDomain
to renew.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 available related domain names represented byEPPRelatedDomainExtDomain
to renew.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 renew- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPRelatedDomainExtRenew
public EPPRelatedDomainExtRenew()
Default constructor
-
EPPRelatedDomainExtRenew
public EPPRelatedDomainExtRenew(java.util.List<EPPRelatedDomainExtDomain> aDomains)
Constructor with a list of domains to be renewed.- Parameters:
aDomains
- List of domains to be renewed
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
A deep clone of the EPPRelatedDomainExtRenew- 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 available related domain names 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 EPPRelatedDomainExtRenew.- 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 renew.- Parameters:
aDomain
- Related domain to add to the list to renew.
-
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 available related domain names represented byEPPRelatedDomainExtDomain
to renew.- Returns:
- the related domains to renew.
-
setDomains
public void setDomains(java.util.List<EPPRelatedDomainExtDomain> aDomains)
Sets the list of available related domain names represented byEPPRelatedDomainExtDomain
to renew.- Parameters:
aDomains
- the related domains to set to renew
-
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
.
-
-