com.verisign.epp.codec.reseller
Class EPPResellerCheckResult

java.lang.Object
  com.verisign.epp.codec.reseller.EPPResellerCheckResult

All Implemented Interfaces:

EPPCodecComponent, java.io.Serializable, java.lang.Cloneable

public class EPPResellerCheckResult
extends java.lang.Object
implements EPPCodecComponent

EPPResellerCheckResult is used to represent the for the check of an individual reseller. The reseller information includes the reseller identifier, whether the reseller identifier is available, and optionally the reason that the reseller identifier is not available.

See Also:

Serialized Form

Field Summary

static java.lang.String	ELM_LOCALNAME XML local name for EPPResellerCheckResult.
static java.lang.String	ELM_NAME XML root tag for EPPResellerCheckResult.

Constructor Summary

EPPResellerCheckResult()
Default constructor for EPPResellerCheckResult.

EPPResellerCheckResult(java.lang.String aResellerId, boolean aAvailable)
Constructor for EPPResellerCheckResult that takes reseller identifier and whether the reseller identifier is available.

EPPResellerCheckResult(java.lang.String aResellerId, java.lang.String aReason)
Constructor for EPPResellerCheckResult that is used for unavailable reseller identifiers providing the reason the reseller identifier is not available.

EPPResellerCheckResult(java.lang.String aResellerId, java.lang.String aReason, java.lang.String aReasonLang)
Constructor for EPPResellerCheckResult that is used for unavailable reseller identifiers providing the reason the reseller identifier is not available with the reason language.

Method Summary

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 EPPResellerCheckResult with this instance.
java.lang.String	getReason() Gets the reason that the reseller identifier is not available.
java.lang.String	getReasonLang() Gets the reason language value.
java.lang.String	getResellerId() Gets the reseller identifier.
boolean	hasReason() Is the reason defined?
boolean	hasReasonLang() Is the reason language defined?
boolean	isAvailable() Is the reseller identifier available?
void	setAvailable(boolean aAvailable) Sets the reseller identifier is available.
void	setReason(java.lang.String aReason) Sets the reason that the reseller identifier is not available.
void	setReasonLang(java.lang.String aReasonLang) Sets the reason language value.
void	setResellerId(java.lang.String aResellerId) Sets the reseller identifier.
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 EPPResellerCheckResult.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPResellerCheckResult.

See Also:

Constant Field Values

Constructor Detail

EPPResellerCheckResult

public EPPResellerCheckResult()

Default constructor for EPPResellerCheckResult.

EPPResellerCheckResult

public EPPResellerCheckResult(java.lang.String aResellerId,
                              boolean aAvailable)

Constructor for EPPResellerCheckResult that takes reseller identifier and whether the reseller identifier is available.

Parameters:

aResellerId - The reseller identifier

aAvailable - Is the reseller identifier available?

EPPResellerCheckResult

public EPPResellerCheckResult(java.lang.String aResellerId,
                              java.lang.String aReason)

Constructor for EPPResellerCheckResult that is used for unavailable reseller identifiers providing the reason the reseller identifier is not available.

Parameters:

aResellerId - The reseller identifier

aReason - Reason that the reseller identifier is not available.

EPPResellerCheckResult

public EPPResellerCheckResult(java.lang.String aResellerId,
                              java.lang.String aReason,
                              java.lang.String aReasonLang)

Constructor for EPPResellerCheckResult that is used for unavailable reseller identifiers providing the reason the reseller identifier is not available with the reason language.

Parameters:

aResellerId - The reseller identifier

aReason - Reason that the reseller identifier is not available.

aReasonLang - Reason language for reason value.

Method Detail

getResellerId

public java.lang.String getResellerId()

Gets the reseller identifier.

Returns:

The reseller identifier if defined;null otherwise.

setResellerId

public void setResellerId(java.lang.String aResellerId)

Sets the reseller identifier.

Parameters:

aResellerId - The reseller identifier

isAvailable

public boolean isAvailable()

Is the reseller identifier available?

Returns:

true if the reseller identifier is available; false otherwise.

setAvailable

public void setAvailable(boolean aAvailable)

Sets the reseller identifier is available.

Parameters:

aAvailable - true if the reseller identifier is available; false otherwise.

hasReason

public boolean hasReason()

Is the reason defined?

Returns:

true if the reason is defined; false otherwise.

getReason

public java.lang.String getReason()

Gets the reason that the reseller identifier is not available.

Returns:

Reason that the reseller identifier is not available if defined; null otherwise.

setReason

public void setReason(java.lang.String aReason)

Sets the reason that the reseller identifier is not available.

Parameters:

aReason - Reason that the reseller identifier is not available. Set to null to clear the reason.

hasReasonLang

public boolean hasReasonLang()

Is the reason language defined?

Returns:

true if the reason language is defined; false otherwise.

getReasonLang

public java.lang.String getReasonLang()

Gets the reason language value.

Returns:

Reason language if defined; null otherwise.

setReasonLang

public void setReasonLang(java.lang.String aReasonLang)

Sets the reason language value.

Parameters:

aReasonLang - Reason language for reason value.

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 EPPResellerCheckResult

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 EPPResellerCheckResult

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 EPPResellerCheckResult with this instance.

Overrides:

equals in class java.lang.Object

Parameters:

aObject - Object to compare with.

Returns:

true if equal; false otherwise.