Package com.verisign.epp.codec.contact
Class EPPContactPendActionMsg
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.contact.EPPContactPendActionMsg
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPContactPendActionMsg extends EPPResponse
Poll message used to indicate the result of a pending action. Pending action can included contact create, update, renew, 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 EPPContactPendActionMsg()
EPPContactPendActionMsg
default constructor.EPPContactPendActionMsg(EPPTransId aTransId, java.lang.String aId, boolean aSuccess, EPPTransId aPendingTransId, java.util.Date aPendingDate)
EPPContactPendActionMsg
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()
CloneEPPContactPendActionMsg
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPContactPendActionMsg
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 theEPPContactPendActionMsg
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPContactPendActionMsg
with this instance.java.lang.String
getId()
Gets the contact idjava.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPContactPendActionMsg
.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 withEPPContactPendActionMsg
.boolean
isSuccess()
Was the pending action successful?void
setId(java.lang.String aId)
Sets the contact id.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
-
EPPContactPendActionMsg
public EPPContactPendActionMsg()
EPPContactPendActionMsg
default constructor. Must call required setter methods before encode.
-
EPPContactPendActionMsg
public EPPContactPendActionMsg(EPPTransId aTransId, java.lang.String aId, boolean aSuccess, EPPTransId aPendingTransId, java.util.Date aPendingDate)
EPPContactPendActionMsg
constructor that takes all of the required attributes.- Parameters:
aTransId
- Poll command transaction idaId
- Contact id 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 withEPPContactPendActionMsg
.- Overrides:
getType
in classEPPResponse
- Returns:
- EPPContactPendActionMsg.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPContactPendActionMsg
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPContactMapFactory.NS
-
getId
public java.lang.String getId()
Gets the contact id- Returns:
- Contact Id
String
instance if defined;null
otherwise.
-
setId
public void setId(java.lang.String aId)
Sets the contact id.- Parameters:
aId
- Contact Id
-
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 ofEPPContactPendActionMsg
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
CloneEPPContactPendActionMsg
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPContactPendActionMsg
- 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 theEPPContactPendActionMsg
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
EPPContactPendActionMsg
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPContactPendActionMsg
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPContactPendActionMsg
attributes from theaElement
DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPContactPendActionMsg
from.- Throws:
EPPDecodeException
- Unable to decodeaElement
-
-