public class EPPRelatedDomainExtGroup extends java.lang.Object implements EPPCodecComponent
Title: EPP 1.0 Related Domain - group tag
Description: The EPPRelatedDomainExtGroup object represents the collection of
domains that are available for registration in a family of related domains.
As such it is composed of EPPRelatedDomainExtFields
,
EPPRelatedDomainExtAvailable
and
EPPRelatedDomainExtRegistered
objects.
As XML, it is represented by a
Copyright: Copyright (c) 2013
Company: VeriSign
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ELM_NAME
Element tag name for the group
|
static java.lang.String |
TYPE_TLD
Relationship of domains is based on Top Level Domain (TLD) relationship.
|
static java.lang.String |
TYPE_VARIANT
Relationship of domains is based on variant relationship within a Top Level Domain (TLD).
|
Constructor and Description |
---|
EPPRelatedDomainExtGroup()
Default constructor
|
EPPRelatedDomainExtGroup(java.lang.String aType,
EPPRelatedDomainExtFields aFields)
Constructor that takes the required attributes including the
type and the fields . |
EPPRelatedDomainExtGroup(java.lang.String aType,
EPPRelatedDomainExtFields aFields,
EPPRelatedDomainExtAvailable aAvailable,
EPPRelatedDomainExtRegistered aRegistered)
Constructor that takes all of the attributes as parameters.
|
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
A deep clone of the EPPRelatedDomainAvailable
|
void |
decode(org.w3c.dom.Element aElement)
Populate the data of this instance with the data stored in the given
Element of the DOM tree
|
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Append all data from this group to the given DOM Document
|
boolean |
equals(java.lang.Object obj) |
EPPRelatedDomainExtAvailable |
getAvailable()
Returns the available
|
EPPRelatedDomainExtFields |
getFields()
Returns the fields
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
EPPRelatedDomainExtRegistered |
getRegistered()
Returns the registered
|
java.lang.String |
getType()
Returns the type
|
void |
setAvailable(EPPRelatedDomainExtAvailable aAvailable)
Sets available value to aAvailable
|
void |
setFields(EPPRelatedDomainExtFields aFields)
Sets fields value to aFields
|
void |
setRegistered(EPPRelatedDomainExtRegistered aRegistered)
Sets registered value to aRegistered
|
void |
setType(java.lang.String aType)
Sets type value to aType
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String ELM_NAME
public static final java.lang.String TYPE_TLD
public static final java.lang.String TYPE_VARIANT
public EPPRelatedDomainExtGroup()
public EPPRelatedDomainExtGroup(java.lang.String aType, EPPRelatedDomainExtFields aFields)
type
and the fields
.aType
- What type of group is it? One of the TYPE
constants may be used.aFields
- The field information for the grouppublic EPPRelatedDomainExtGroup(java.lang.String aType, EPPRelatedDomainExtFields aFields, EPPRelatedDomainExtAvailable aAvailable, EPPRelatedDomainExtRegistered aRegistered)
aType
- What type of group is it? One of the TYPE
constants may be used.aFields
- The field information for the groupaAvailable
- The list of available related names for the group.aRegistered
- The list of registered related name for the group.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPCodecComponent
java.lang.CloneNotSupportedException
- standard Object.clone exceptionObject.clone()
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode
in interface EPPCodecComponent
aElement
- The root element of the report fragment of XMLEPPDecodeException
- Thrown if any errors occur during decoding.public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- The DOM Document to append data toElement
EPPEncodeException
- Thrown when errors occur during the encode attempt or if the
instance is invalid.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public EPPRelatedDomainExtAvailable getAvailable()
public EPPRelatedDomainExtFields getFields()
public EPPRelatedDomainExtRegistered getRegistered()
public java.lang.String getType()
public void setAvailable(EPPRelatedDomainExtAvailable aAvailable)
aAvailable
- the available to setpublic void setFields(EPPRelatedDomainExtFields aFields)
aFields
- the fields to setpublic void setRegistered(EPPRelatedDomainExtRegistered aRegistered)
aRegistered
- the registered to setpublic void setType(java.lang.String aType)
aType
- the type to setpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.