com.verisign.epp.codec.emailFwd

Class EPPEmailFwdCheckResp

java.lang.Object

com.verisign.epp.codec.gen.EPPResponse

com.verisign.epp.codec.emailFwd.EPPEmailFwdCheckResp

All Implemented Interfaces:

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

public class EPPEmailFwdCheckResp
extends EPPResponse

Represents an EPP EmailFwd <emailFwd:chkData> response to a EPPEmailFwdCheckCmd. When a <check> command has been processed successfully, the EPP <resData> element MUST contain a child <emailFwd:chkData> element that identifies the emailFwd namespace and the location of the emailFwd schema. The <emailFwd:chkData> elements that contain the following child elements:

• A <emailFwd:name> element that contains the fully qualified name of the queried emailFwd object. This element MUST contain an "avail" attribute whose value indicates object availability at the moment the <check> command was completed. A value of "1" or "true" menas that the object is availabe. A value of "0" or "false" means that the object is not available.
• An OPTIONAL <emailFwd:reason> element that MAY be provided when an object is not available for provisioning. If present, this element contains server-specific text to help explain why the object is unavailable. This text MUST be represented in the response language previously negotiated with the client; an OPTIONAL "lang" attribute MAY be present to identify the language if the negotiated value is something other that a default value of "en" (English).

See Also:

EPPEmailFwdCheckCmd, EPPEmailFwdCheckResult, Serialized Form

Field Summary

Fields inherited from class com.verisign.epp.codec.gen.EPPResponse

extensions, TRANSFER_CLIENT_APPROVED, TRANSFER_CLIENT_CANCELLED, TRANSFER_CLIENT_REJECTED, TRANSFER_PENDING, TRANSFER_SERVER_APPROVED, TRANSFER_SERVER_CANCELLED

Constructor Summary

Constructors

Constructor and Description
EPPEmailFwdCheckResp() EPPEmailFwdCheckResp default constructor.
EPPEmailFwdCheckResp(EPPTransId aTransId, EPPEmailFwdCheckResult aResult) EPPEmailFwdCheckResp constructor that will set the result of an individual emailFwd.
EPPEmailFwdCheckResp(EPPTransId aTransId, java.util.Vector someResults) EPPEmailFwdCheckResp constructor that will set the result of multiple emailFwds.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Clone EPPEmailFwdCheckResp.
protected void	doDecode(org.w3c.dom.Element aElement) Decode the EPPEmailFwdCheckResp attributes from the aElement DOM Element tree.
protected org.w3c.dom.Element	doEncode(org.w3c.dom.Document aDocument) Encode a DOM Element tree from the attributes of the EPPEmailFwdCheckResp instance.
boolean	equals(java.lang.Object aObject) Compare an instance of EPPEmailFwdCheckResp with this instance.
java.util.Vector	getCheckResults() Get the results of a EPPEmailFwdCheckResp Response.
java.lang.String	getNamespace() Get the EPP command Namespace associated with EPPEmailFwdCheckResp.
java.lang.String	getType() Get the EPP response type associated with EPPEmailFwdCheckResp.
void	setCheckResults(java.util.Vector someResults) Set the results of a EPPEmailFwdCheckResp Response.
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 com.verisign.epp.codec.gen.EPPResponse

addExtension, decode, encode, getExtension, getExtension, getExtensions, getMessageQueue, getMsgQueue, getMsgQueueCount, getMsgQueueDate, getMsgQueueMsg, getQDate, getResult, getResults, getTransId, hasExtension, hasExtensions, hasMessageQueue, hasMsgQueue, hasResultCode, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId

Methods inherited from class java.lang.Object

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

Constructor Detail

EPPEmailFwdCheckResp

public EPPEmailFwdCheckResp()

EPPEmailFwdCheckResp default constructor. It will set results attribute to an empty Vector.

EPPEmailFwdCheckResp

public EPPEmailFwdCheckResp(EPPTransId aTransId,
                            EPPEmailFwdCheckResult aResult)

EPPEmailFwdCheckResp constructor that will set the result of an individual emailFwd.

Parameters:

aTransId - Transaction Id associated with response.

aResult - Result of a single emailFwd name.

EPPEmailFwdCheckResp

public EPPEmailFwdCheckResp(EPPTransId aTransId,
                            java.util.Vector someResults)

EPPEmailFwdCheckResp constructor that will set the result of multiple emailFwds.

Parameters:

aTransId - Transaction Id associated with response.

someResults - Vector of EPPEmailFwdCheckResult instances.

Method Detail

getType

public java.lang.String getType()

Get the EPP response type associated with EPPEmailFwdCheckResp.

Overrides:

getType in class EPPResponse

Returns:

EPPEmailFwdCheckResp.ELM_NAME

getNamespace

public java.lang.String getNamespace()

Get the EPP command Namespace associated with EPPEmailFwdCheckResp.

Specified by:

getNamespace in interface EPPCodecComponent

Specified by:

getNamespace in interface EPPMessage

Overrides:

getNamespace in class EPPResponse

Returns:

EPPEmailFwdMapFactory.NS

equals

public boolean equals(java.lang.Object aObject)

Compare an instance of EPPEmailFwdCheckResp with this instance.

Overrides:

equals in class EPPResponse

Parameters:

aObject - Object to compare with.

Returns:

DOCUMENT ME!

clone

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

Clone EPPEmailFwdCheckResp.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPResponse

Returns:

clone of EPPEmailFwdCheckResp

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 EPPResponse

Returns:

Indented XML String if successful; ERROR otherwise.

setCheckResults

public void setCheckResults(java.util.Vector someResults)

Set the results of a EPPEmailFwdCheckResp Response. There is one EPPEmailFwdCheckResult instance in someResults for each emailFwd requested in the EPPEmailFwdCheckCmd Command.

Parameters:

someResults - Vector of EPPEmailFwdCheckResult instances.

getCheckResults

public java.util.Vector getCheckResults()

Get the results of a EPPEmailFwdCheckResp Response. There is one EPPEmailFwdCheckResult instance in someResults for each emailFwd requested in the EPPEmailFwdCheckResult Command.

Returns:

Vector of EPPEmailFwdCheckResult instances.

doEncode

protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPEmailFwdCheckResp instance.

Overrides:

doEncode in class EPPResponse

Parameters:

aDocument - DOM Document that is being built. Used as an Element factory.

Returns:

Element Root DOM Element representing the EPPEmailFwdCheckResp instance. emailFwd

Throws:

EPPEncodeException - Unable to encode EPPEmailFwdCheckResp instance.

doDecode

protected void doDecode(org.w3c.dom.Element aElement)
                 throws EPPDecodeException

Decode the EPPEmailFwdCheckResp attributes from the aElement DOM Element tree.

Overrides:

doDecode in class EPPResponse

Parameters:

aElement - Root DOM Element to decode EPPEmailFwdCheckResp from.

Throws:

EPPDecodeException - Unable to decode aElement