Package com.verisign.epp.codec.orgext
Class EPPOrgExtCreate
- java.lang.Object
-
- com.verisign.epp.codec.orgext.EPPOrgExtCreate
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPOrgExtCreate extends java.lang.Object implements EPPCodecComponent
EPPOrgExtCreate
is used in the extension to the create command to define the org identifiers.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPOrgExtCreate
.static java.lang.String
ELM_NAME
XML root tag forEPPOrgExtCreate
.
-
Constructor Summary
Constructors Constructor Description EPPOrgExtCreate()
Default constructor forEPPOrgExtCreate
.EPPOrgExtCreate(EPPOrgExtId aOrgId)
Constructor forEPPOrgExtCreate
that takes a single organization id.EPPOrgExtCreate(java.util.List<EPPOrgExtId> aOrgIds)
Constructor forEPPOrgExtCreate
that takes a list of organization ids.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addOrgId(EPPOrgExtId aOrgId)
Add a organization id to the list of organization ids.java.lang.Object
clone()
clone anEPPCodecComponent
.void
decode(org.w3c.dom.Element aElement)
decode a DOM element tree to initialize the instance attributes.org.w3c.dom.Element
encode(org.w3c.dom.Document aDocument)
encode instance into a DOM element tree.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPOrgExt
with this instance.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.java.util.List<EPPOrgExtId>
getOrgIds()
Returns the list of organization ids.boolean
hasOrgIds()
Are there any organization ids?void
setOrgIds(java.util.List<EPPOrgExtId> aOrgIds)
Sets the organization ids.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
ELM_LOCALNAME
public static final java.lang.String ELM_LOCALNAME
XML local name forEPPOrgExtCreate
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPOrgExtCreate
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPOrgExtCreate
public EPPOrgExtCreate()
Default constructor forEPPOrgExtCreate
.
-
EPPOrgExtCreate
public EPPOrgExtCreate(EPPOrgExtId aOrgId)
Constructor forEPPOrgExtCreate
that takes a single organization id.- Parameters:
aOrgId
- Organization identifier
-
EPPOrgExtCreate
public EPPOrgExtCreate(java.util.List<EPPOrgExtId> aOrgIds)
Constructor forEPPOrgExtCreate
that takes a list of organization ids.- Parameters:
aOrgIds
- Organization identifiers
-
-
Method Detail
-
hasOrgIds
public boolean hasOrgIds()
Are there any organization ids?- Returns:
true
if there organization ids;false
otherwise.
-
getOrgIds
public java.util.List<EPPOrgExtId> getOrgIds()
Returns the list of organization ids. An empty list indicates that there are no organization ids.- Returns:
- List of organization ids.
-
setOrgIds
public void setOrgIds(java.util.List<EPPOrgExtId> aOrgIds)
Sets the organization ids.- Parameters:
aOrgIds
- The list of organization ids. Set tonull
or an empty list to indicate that there are no organization ids.
-
addOrgId
public void addOrgId(EPPOrgExtId aOrgId)
Add a organization id to the list of organization ids.- Parameters:
aOrgId
- organization id to add to the list of organization ids.
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- DOM Document, which acts is an Element factory- Returns:
- Element Root element associated with the object
- Throws:
EPPEncodeException
- Error encodingEPPOrgExtCreate
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode a DOM element tree to initialize the instance attributes. TheaElement
argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
-Element
to decode- Throws:
EPPDecodeException
- Error decodingElement
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
clone anEPPCodecComponent
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of concrete
EPPOrgExt
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
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.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPOrgExt
with this instance.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
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
.
-
-