|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.emailFwd.EPPEmailFwdTransferResp
public class EPPEmailFwdTransferResp
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:
getName
and setName
to get and set the element.
getRequestClient
and setRequestClient
to get
and set the element.
getActionClient
and setActionClient
to get
and set the element.
getStatus
and setStatus
with the
EPPEmailFwdTransferResp.STATUS_
constants to get and set
the element.
getRequestDate
and
setRequestDate
to get and set the element.
getActionDate
and setActionDate
to get and set the element.
getExpirationDate
and
setExpirationDate
to get and set the element.
EPPEmailFwdTransferCmd
,
Serialized FormField 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 |
---|
public EPPEmailFwdTransferResp()
EPPEmailFwdTransferResp
default constructor. Must call
required setter methods before invoking encode
, which
include:setName
setRequestClient
setActionClient
setTransferStatus
setReqeustDate
setActionDate
setTransId
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:setRequestClient
setActionClient
setTransferStatus
setReqeustDate
setActionDate
aTransId
- Transaction Id associated with response.aName
- EmailFwd nameMethod Detail |
---|
public java.lang.String getType()
EPPEmailFwdTransferResp
.
getType
in class EPPResponse
EPPEmailFwdTransferResp.ELM_NAME
public java.lang.String getNamespace()
EPPEmailFwdTransferResp
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPResponse
EPPEmailFwdMapFactory.NS
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPEmailFwdTransferResp
instance.
doEncode
in class EPPResponse
aDocument
- DOM Document that is being built. Used as an Element
factory.
EPPEmailFwdTransferResp
instance.
EPPEncodeException
- Unable to encode
EPPEmailFwdTransferResp
instance.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPEmailFwdTransferResp
attributes from the
aElement DOM Element tree.
doDecode
in class EPPResponse
aElement
- Root DOM Element to decode
EPPEmailFwdTransferResp
from.
EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPEmailFwdTransferResp
with this
instance.
equals
in class EPPResponse
aObject
- Object to compare with.
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPEmailFwdTransferResp
.
clone
in interface EPPCodecComponent
clone
in class EPPResponse
EPPEmailFwdTransferResp
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class EPPResponse
String
if successful;
ERROR
otherwise.public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- EmailFwd Namepublic java.lang.String getRequestClient()
String
if defined;
null
otherwise.public void setRequestClient(java.lang.String aRequestClient)
aRequestClient
- The Request Client Id String
public java.lang.String getActionClient()
String
if defined;
null
otherwise.public void setActionClient(java.lang.String aActionClient)
aActionClient
- The Action Client Id String
public java.lang.String getTransferStatus()
EPPResponse.TRANSFER
constants.
String
if defined;
null
otherwise.public void setTransferStatus(java.lang.String aTransferStatus)
EPPResponse.TRANSFER
constants.
aTransferStatus
- The transfer status String
(EPPResponse.TRANSFER
)public java.util.Date getRequestDate()
null
otherwise.public void setRequestDate(java.util.Date aRequestDate)
aRequestDate
- The request date and timepublic java.util.Date getActionDate()
null
otherwise.public void setActionDate(java.util.Date aActionDate)
aActionDate
- The required or complete response data and time.public java.util.Date getExpirationDate()
null
otherwise.public void setExpirationDate(java.util.Date aExpirationDate)
aExpirationDate
- Transfer expiration data and time.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |