Package com.verisign.epp.codec.emailFwd
Class EPPEmailFwdPendActionMsg
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.emailFwd.EPPEmailFwdPendActionMsg
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPEmailFwdPendActionMsg extends EPPResponse
Poll message used to indicate the result of a pending action. Pending action can included emailFwd create, update, renew, transfer, and delete.
-
-
Field Summary
-
Fields inherited from class com.verisign.epp.codec.gen.EPPResponse
ELM_EXTENSION, ELM_MESSAGE_QUEUE, ELM_MESSAGE_QUEUE_QDATE, ELM_RESPONSE_DATA, extensions, TRANSFER_CLIENT_APPROVED, TRANSFER_CLIENT_CANCELLED, TRANSFER_CLIENT_REJECTED, TRANSFER_PENDING, TRANSFER_SERVER_APPROVED, TRANSFER_SERVER_CANCELLED
-
-
Constructor Summary
Constructors Constructor Description EPPEmailFwdPendActionMsg()
EPPEmailFwdPendActionMsg
default constructor.EPPEmailFwdPendActionMsg(EPPTransId aTransId, java.lang.String aName, boolean aSuccess, EPPTransId aPendingTransId, java.util.Date aPendingDate)
EPPEmailFwdPendActionMsg
constructor that takes all of the required attributes.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPEmailFwdPendActionMsg
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPEmailFwdPendActionMsg
attributes from theaElement
DOM Element tree.protected org.w3c.dom.Element
doEncode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of theEPPEmailFwdPendActionMsg
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdPendActionMsg
with this instance.java.lang.String
getName()
Gets the emailFwd namejava.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPEmailFwdPendActionMsg
.java.util.Date
getPendingDate()
Gets the date that the pending action was completed.EPPTransId
getPendingTransId()
Gets the pending transaction id.java.lang.String
getType()
Gets the EPP command type associated withEPPEmailFwdPendActionMsg
.boolean
isSuccess()
Was the pending action successful?void
setName(java.lang.String aName)
Sets the emailFwd name.void
setPendingDate(java.util.Date pendingDate)
Sets the date that the pending action was completed.void
setPendingTransId(EPPTransId pendingTransId)
Sets the pending transaction id.void
setSuccess(boolean success)
Sets if the pending action was successful.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.-
Methods inherited from class com.verisign.epp.codec.gen.EPPResponse
addExtension, decode, encode, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getMessageQueue, getMsgQueue, getMsgQueueCount, getMsgQueueDate, getMsgQueueMsg, getQDate, getResult, getResults, getTransId, hasExtension, hasExtensions, hasMessageQueue, hasMsgQueue, hasResultCode, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId
-
-
-
-
Constructor Detail
-
EPPEmailFwdPendActionMsg
public EPPEmailFwdPendActionMsg()
EPPEmailFwdPendActionMsg
default constructor. Must call required setter methods before encode.
-
EPPEmailFwdPendActionMsg
public EPPEmailFwdPendActionMsg(EPPTransId aTransId, java.lang.String aName, boolean aSuccess, EPPTransId aPendingTransId, java.util.Date aPendingDate)
EPPEmailFwdPendActionMsg
constructor that takes all of the required attributes.- Parameters:
aTransId
- Poll command transaction idaName
- EmailFwd name of pending actionaSuccess
- Was the pending action successfulaPendingTransId
- Pending action transaction idaPendingDate
- Date of pending action completion
-
-
Method Detail
-
getType
public java.lang.String getType()
Gets the EPP command type associated withEPPEmailFwdPendActionMsg
.- Overrides:
getType
in classEPPResponse
- Returns:
- EPPEmailFwdPendActionMsg.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPEmailFwdPendActionMsg
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPEmailFwdMapFactory.NS
-
getName
public java.lang.String getName()
Gets the emailFwd name- Returns:
- EmailFwd Name
String
instance if defined;null
otherwise.
-
setName
public void setName(java.lang.String aName)
Sets the emailFwd name.- Parameters:
aName
- EmailFwd Name
-
getPendingDate
public java.util.Date getPendingDate()
Gets the date that the pending action was completed.- Returns:
- Returns the pendingDate.
-
setPendingDate
public void setPendingDate(java.util.Date pendingDate)
Sets the date that the pending action was completed.- Parameters:
pendingDate
- The pendingDate to set.
-
getPendingTransId
public EPPTransId getPendingTransId()
Gets the pending transaction id.- Returns:
- Returns the pendingTransId.
-
setPendingTransId
public void setPendingTransId(EPPTransId pendingTransId)
Sets the pending transaction id.- Parameters:
pendingTransId
- The pendingTransId to set.
-
isSuccess
public boolean isSuccess()
Was the pending action successful?- Overrides:
isSuccess
in classEPPResponse
- Returns:
- Returns
true
if the pending action was successfully completed;false
otherwise.
-
setSuccess
public void setSuccess(boolean success)
Sets if the pending action was successful.- Parameters:
success
- The success to set.
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdPendActionMsg
with this instance.- Overrides:
equals
in classEPPResponse
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPEmailFwdPendActionMsg
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPEmailFwdPendActionMsg
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classEPPResponse
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPEmailFwdPendActionMsg
instance.- Overrides:
doEncode
in classEPPResponse
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPEmailFwdPendActionMsg
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPEmailFwdPendActionMsg
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPEmailFwdPendActionMsg
attributes from theaElement
DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPEmailFwdPendActionMsg
from.- Throws:
EPPDecodeException
- Unable to decodeaElement
-
-