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 and Description
static java.lang.String	ELM_LOCALNAME XML local name for EPPOrgExtId.
static java.lang.String	ELM_NAME XML root tag for EPPOrgExtId.

Constructor Summary

Constructors

Constructor and Description
EPPOrgExtId() Default constructor for EPPOrgExtId.
EPPOrgExtId(java.lang.String aRole) Constructor for EPPOrgExtId that takes the role.
EPPOrgExtId(java.lang.String aRole, java.lang.String aOrgId) Constructor for EPPOrgExtId that takes the role and the organization identifier value.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() clone an EPPCodecComponent.
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 of EPPOrgExt with this instance.
java.lang.String	getNamespace() Returns the XML namespace associated with the EPPCodecComponent.
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 of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELM_LOCALNAME

public static final java.lang.String ELM_LOCALNAME

XML local name for EPPOrgExtId.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPOrgExtId.

See Also:

Constant Field Values

Constructor Detail

EPPOrgExtId

public EPPOrgExtId()

Default constructor for EPPOrgExtId.

EPPOrgExtId

public EPPOrgExtId(java.lang.String aRole)

Constructor for EPPOrgExtId that takes the role.

Parameters:

aRole - Organization role

EPPOrgExtId

public EPPOrgExtId(java.lang.String aRole,
                   java.lang.String aOrgId)

Constructor for EPPOrgExtId that takes the role and the organization identifier value.

Parameters:

aRole - Organization role

aOrgId - 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 interface EPPCodecComponent

Parameters:

aDocument - DOM Document, which acts is an Element factory

Returns:

Element Root element associated with the object

Throws:

EPPEncodeException - Error encoding EPPOrgExtId

decode

public void decode(org.w3c.dom.Element aElement)
            throws EPPDecodeException

decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - Element to decode

Throws:

EPPDecodeException - Error decoding Element

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

clone an EPPCodecComponent.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class java.lang.Object

Returns:

clone of concrete EPPOrgExt

Throws:

java.lang.CloneNotSupportedException - standard Object.clone exception

toString

public java.lang.String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class java.lang.Object

Returns:

Indented XML String if successful; ERROR otherwise.

equals

public boolean equals(java.lang.Object aObject)

Compare an instance of EPPOrgExt with this instance.

Overrides:

equals in class java.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 the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.