Package com.verisign.epp.codec.domain
Class EPPDomainPendActionMsg
java.lang.Object
com.verisign.epp.codec.gen.EPPResponse
com.verisign.epp.codec.domain.EPPDomainPendActionMsg
- All Implemented Interfaces:
EPPCodecComponent,EPPMessage,Serializable,Cloneable
Poll message used to indicate the result of a pending action. Pending action
can included domain create, update, renew, transfer, and delete.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringXML local name forEPPDomainPendActionMsg.static final StringXML Element Name ofEPPDomainPendActionMsgroot element.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
ConstructorsConstructorDescriptionEPPDomainPendActionMsgdefault constructor.EPPDomainPendActionMsg(EPPTransId aTransId, String aName, boolean aSuccess, EPPTransId aPendingTransId, Date aPendingDate) EPPDomainPendActionMsgconstructor that takes all of the required attributes. -
Method Summary
Modifier and TypeMethodDescriptionclone()CloneEPPDomainPendActionMsg.protected voidDecode theEPPDomainPendActionMsgattributes from theaElementDOM Element tree.protected ElementEncode a DOM Element tree from the attributes of theEPPDomainPendActionMsginstance.booleanCompare an instance ofEPPDomainPendActionMsgwith this instance.getName()Gets the domain nameGets the EPP command Namespace associated withEPPDomainPendActionMsg.Gets the date that the pending action was completed.Gets the pending transaction id.getType()Gets the EPP command type associated withEPPDomainPendActionMsg.booleanWas the pending action successful?voidSets the domain name.voidsetPASuccess(boolean success) Sets if the pending action was successful.voidsetPendingDate(Date pendingDate) Sets the date that the pending action was completed.voidsetPendingTransId(EPPTransId pendingTransId) Sets the pending transaction id.toString()Implementation ofObject.toString, which will result in an indented XMLStringrepresentation 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, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId
-
Field Details
-
ELM_LOCALNAME
XML local name forEPPDomainPendActionMsg.- See Also:
-
ELM_NAME
XML Element Name ofEPPDomainPendActionMsgroot element.- See Also:
-
-
Constructor Details
-
EPPDomainPendActionMsg
public EPPDomainPendActionMsg()EPPDomainPendActionMsgdefault constructor. Must call required setter methods before encode. -
EPPDomainPendActionMsg
public EPPDomainPendActionMsg(EPPTransId aTransId, String aName, boolean aSuccess, EPPTransId aPendingTransId, Date aPendingDate) EPPDomainPendActionMsgconstructor that takes all of the required attributes.- Parameters:
aTransId- Poll command transaction idaName- Domain name of pending actionaSuccess- Was the pending action successfulaPendingTransId- Pending action transaction idaPendingDate- Date of pending action completion
-
-
Method Details
-
getType
Gets the EPP command type associated withEPPDomainPendActionMsg.- Overrides:
getTypein classEPPResponse- Returns:
- EPPDomainPendActionMsg.ELM_NAME
-
getNamespace
Gets the EPP command Namespace associated withEPPDomainPendActionMsg.- Specified by:
getNamespacein interfaceEPPCodecComponent- Specified by:
getNamespacein interfaceEPPMessage- Overrides:
getNamespacein classEPPResponse- Returns:
EPPDomainMapFactory.NS
-
getName
Gets the domain name- Returns:
- Domain Name
Stringinstance if defined;nullotherwise.
-
setName
Sets the domain name.- Parameters:
aName- Domain Name
-
getPendingDate
Gets the date that the pending action was completed.- Returns:
- Returns the pendingDate.
-
setPendingDate
Sets the date that the pending action was completed.- Parameters:
pendingDate- The pendingDate to set.
-
getPendingTransId
Gets the pending transaction id.- Returns:
- Returns the pendingTransId.
-
setPendingTransId
Sets the pending transaction id.- Parameters:
pendingTransId- The pendingTransId to set.
-
isPASuccess
public boolean isPASuccess()Was the pending action successful?- Returns:
- Returns
trueif the pending action was successfully completed;falseotherwise.
-
setPASuccess
public void setPASuccess(boolean success) Sets if the pending action was successful.- Parameters:
success- The success to set.
-
equals
Compare an instance ofEPPDomainPendActionMsgwith this instance.- Overrides:
equalsin classEPPResponse- Parameters:
aObject- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
CloneEPPDomainPendActionMsg.- Specified by:
clonein interfaceEPPCodecComponent- Overrides:
clonein classEPPResponse- Returns:
- clone of
EPPDomainPendActionMsg - Throws:
CloneNotSupportedException- standard Object.clone exception
-
toString
Implementation ofObject.toString, which will result in an indented XMLStringrepresentation of the concreteEPPCodecComponent.- Overrides:
toStringin classEPPResponse- Returns:
- Indented XML
Stringif successful;ERRORotherwise.
-
doEncode
Encode a DOM Element tree from the attributes of theEPPDomainPendActionMsginstance.- Overrides:
doEncodein classEPPResponse- Parameters:
aDocument- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPDomainPendActionMsginstance. - Throws:
EPPEncodeException- Unable to encodeEPPDomainPendActionMsginstance.
-
doDecode
Decode theEPPDomainPendActionMsgattributes from theaElementDOM Element tree.- Overrides:
doDecodein classEPPResponse- Parameters:
aElement- Root DOM Element to decodeEPPDomainPendActionMsgfrom.- Throws:
EPPDecodeException- Unable to decodeaElement
-