com.verisign.epp.codec.emailFwd
Class EPPEmailFwdTransferResp

java.lang.Object
  extended by com.verisign.epp.codec.gen.EPPResponse
      extended by com.verisign.epp.codec.emailFwd.EPPEmailFwdTransferResp
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable

public class EPPEmailFwdTransferResp
extends EPPResponse

Represents an EPP EmailFwd <emailFwd:transfer-data> response to an EPPEmailFwdTransferCmd. When a <transfer> query command has been processed successfully, the EPP <resData> element MUST conemailFwdtain a child <emailFwd:trnData> element that identifies the emailFwd namespace and the location of the emailFwd schema. The <emailFwd:trnData> element SHALL contain the following child elements:



Version:
$Revision: 1.2 $
Author:
$Author: jim $
See Also:
EPPEmailFwdTransferCmd, 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
EPPEmailFwdTransferResp()
          EPPEmailFwdTransferResp default constructor.
EPPEmailFwdTransferResp(EPPTransId aTransId, java.lang.String aName)
          EPPEmailFwdTransferResp which takes the name of emailFwd.
 
Method Summary
 java.lang.Object clone()
          Clone EPPEmailFwdTransferResp.
protected  void doDecode(org.w3c.dom.Element aElement)
          Decode the EPPEmailFwdTransferResp 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 EPPEmailFwdTransferResp instance.
 boolean equals(java.lang.Object aObject)
          Compare an instance of EPPEmailFwdTransferResp with this instance.
 java.lang.String getActionClient()
          Gets the identifier of the client that SHOULD respond to the transfer request.
 java.util.Date getActionDate()
          Gets the date and time of a required or completed response.
 java.util.Date getExpirationDate()
          Gets the optional attribute that contains the end of the emailFwd's validity period if the transfer command caused or causes a change in the validity period.
 java.lang.String getName()
          Gets the emailFwd name
 java.lang.String getNamespace()
          Gets the EPP command Namespace associated with EPPEmailFwdTransferResp.
 java.lang.String getRequestClient()
          Gets the identifier of the client that initiated the transfer request.
 java.util.Date getRequestDate()
          Gets the date and time that the transfer was requested.
 java.lang.String getTransferStatus()
          Gets the state of the most recent transfer request.
 java.lang.String getType()
          Gets the EPP response type associated with EPPEmailFwdTransferResp.
 void setActionClient(java.lang.String aActionClient)
          Sets the identifier of the client that SHOULD respond to the transfer request.
 void setActionDate(java.util.Date aActionDate)
          Sets the date and time of a required or completed response.
 void setExpirationDate(java.util.Date aExpirationDate)
          Sets the optional attribute that contains the end of the emailFwd's validity period if the transfer command caused or causes a change in the validity period.
 void setName(java.lang.String aName)
          Sets the emailFwd name.
 void setRequestClient(java.lang.String aRequestClient)
          Sets the identifier of the client that initiated the transfer request.
 void setRequestDate(java.util.Date aRequestDate)
          Sets the date and time that the transfer was requested.
 void setTransferStatus(java.lang.String aTransferStatus)
          Sets the state of the most recent transfer request.
 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

EPPEmailFwdTransferResp

public EPPEmailFwdTransferResp()
EPPEmailFwdTransferResp default constructor. Must call required setter methods before invoking encode, which include:


EPPEmailFwdTransferResp

public EPPEmailFwdTransferResp(EPPTransId aTransId,
                               java.lang.String aName)
EPPEmailFwdTransferResp which takes the name of emailFwd. All other required attributes need to be set using the setter methods, which include:

Parameters:
aTransId - Transaction Id associated with response.
aName - EmailFwd name
Method Detail

getType

public java.lang.String getType()
Gets the EPP response type associated with EPPEmailFwdTransferResp.

Overrides:
getType in class EPPResponse
Returns:
EPPEmailFwdTransferResp.ELM_NAME

getNamespace

public java.lang.String getNamespace()
Gets the EPP command Namespace associated with EPPEmailFwdTransferResp.

Specified by:
getNamespace in interface EPPMessage
Overrides:
getNamespace in class EPPResponse
Returns:
EPPEmailFwdMapFactory.NS

doEncode

protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException
Encode a DOM Element tree from the attributes of the EPPEmailFwdTransferResp instance.

Overrides:
doEncode in class EPPResponse
Parameters:
aDocument - DOM Document that is being built. Used as an Element factory.
Returns:
Root DOM Element representing the EPPEmailFwdTransferResp instance.
Throws:
EPPEncodeException - Unable to encode EPPEmailFwdTransferResp instance.

doDecode

protected void doDecode(org.w3c.dom.Element aElement)
                 throws EPPDecodeException
Decode the EPPEmailFwdTransferResp attributes from the aElement DOM Element tree.

Overrides:
doDecode in class EPPResponse
Parameters:
aElement - Root DOM Element to decode EPPEmailFwdTransferResp from.
Throws:
EPPDecodeException - Unable to decode aElement

equals

public boolean equals(java.lang.Object aObject)
Compare an instance of EPPEmailFwdTransferResp 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 EPPEmailFwdTransferResp.

Specified by:
clone in interface EPPCodecComponent
Overrides:
clone in class EPPResponse
Returns:
clone of EPPEmailFwdTransferResp
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.

getName

public java.lang.String getName()
Gets the emailFwd name

Returns:
EmailFwd Name if set; null otherwise.

setName

public void setName(java.lang.String aName)
Sets the emailFwd name.

Parameters:
aName - EmailFwd Name

getRequestClient

public java.lang.String getRequestClient()
Gets the identifier of the client that initiated the transfer request.

Returns:
The Request Client Id String if defined; null otherwise.

setRequestClient

public void setRequestClient(java.lang.String aRequestClient)
Sets the identifier of the client that initiated the transfer request.

Parameters:
aRequestClient - The Request Client Id String

getActionClient

public java.lang.String getActionClient()
Gets the identifier of the client that SHOULD respond to the transfer request.

Returns:
The Request Client Id String if defined; null otherwise.

setActionClient

public void setActionClient(java.lang.String aActionClient)
Sets the identifier of the client that SHOULD respond to the transfer request.

Parameters:
aActionClient - The Action Client Id String

getTransferStatus

public java.lang.String getTransferStatus()
Gets the state of the most recent transfer request. This should be one of the EPPResponse.TRANSFER constants.

Returns:
The transfer status String if defined; null otherwise.

setTransferStatus

public void setTransferStatus(java.lang.String aTransferStatus)
Sets the state of the most recent transfer request. This should be one of the EPPResponse.TRANSFER constants.

Parameters:
aTransferStatus - The transfer status String (EPPResponse.TRANSFER)

getRequestDate

public java.util.Date getRequestDate()
Gets the date and time that the transfer was requested.

Returns:
The request date and time if defined; null otherwise.

setRequestDate

public void setRequestDate(java.util.Date aRequestDate)
Sets the date and time that the transfer was requested.

Parameters:
aRequestDate - The request date and time

getActionDate

public java.util.Date getActionDate()
Gets the date and time of a required or completed response.

Returns:
The required or complete response data and time if defined; null otherwise.

setActionDate

public void setActionDate(java.util.Date aActionDate)
Sets the date and time of a required or completed response.

Parameters:
aActionDate - The required or complete response data and time.

getExpirationDate

public java.util.Date getExpirationDate()
Gets the optional attribute that contains the end of the emailFwd's validity period if the transfer command caused or causes a change in the validity period.

Returns:
Transfer expiration data and time if defined; null otherwise.

setExpirationDate

public void setExpirationDate(java.util.Date aExpirationDate)
Sets the optional attribute that contains the end of the emailFwd's validity period if the transfer command caused or causes a change in the validity period.

Parameters:
aExpirationDate - Transfer expiration data and time.


Copyright © VeriSign Inc. All Rights Reserved.