Package com.verisign.epp.codec.orgext
Class EPPOrgExtId
- java.lang.Object
-
- com.verisign.epp.codec.orgext.EPPOrgExtId
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPOrgExtId extends java.lang.Object implements EPPCodecComponent
EPPOrgExtId
is used to define an organization identifier with a required role. The organization identifier can be empty in the case of a delete.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ELM_LOCALNAME
XML local name forEPPOrgExtId
.static java.lang.String
ELM_NAME
XML root tag forEPPOrgExtId
.
-
Constructor Summary
Constructors Constructor Description EPPOrgExtId()
Default constructor forEPPOrgExtId
.EPPOrgExtId(java.lang.String aRole)
Constructor forEPPOrgExtId
that takes the role.EPPOrgExtId(java.lang.String aRole, java.lang.String aOrgId)
Constructor forEPPOrgExtId
that takes the role and the organization identifier value.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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.lang.String
getOrgId()
Gets the organization identifier.java.lang.String
getRole()
Gets the organization role.boolean
hasOrgId()
Is the organization identifier defined?void
setOrgId(java.lang.String aOrgId)
Sets the organization identifier.void
setRole(java.lang.String aRole)
Sets the organization role.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 forEPPOrgExtId
.- See Also:
- Constant Field Values
-
ELM_NAME
public static final java.lang.String ELM_NAME
XML root tag forEPPOrgExtId
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPOrgExtId
public EPPOrgExtId()
Default constructor forEPPOrgExtId
.
-
EPPOrgExtId
public EPPOrgExtId(java.lang.String aRole)
Constructor forEPPOrgExtId
that takes the role.- Parameters:
aRole
- Organization role
-
EPPOrgExtId
public EPPOrgExtId(java.lang.String aRole, java.lang.String aOrgId)
Constructor forEPPOrgExtId
that takes the role and the organization identifier value.- Parameters:
aRole
- Organization roleaOrgId
- Organization identifier
-
-
Method Detail
-
hasOrgId
public boolean hasOrgId()
Is the organization identifier defined?- Returns:
true
if the organization identifier is defined;false
otherwise.
-
getOrgId
public java.lang.String getOrgId()
Gets the organization identifier.- Returns:
- The organization identifier if defined;
null
otherwise.
-
setOrgId
public void setOrgId(java.lang.String aOrgId)
Sets the organization identifier.- Parameters:
aOrgId
- The organization identifier
-
getRole
public java.lang.String getRole()
Gets the organization role.- Returns:
- The organization role if defined;
null
otherwise.
-
setRole
public void setRole(java.lang.String aRole)
Sets the organization role.- Parameters:
aRole
- The organization role
-
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 encodingEPPOrgExtId
-
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
.
-
-