Package com.verisign.epp.codec.contact
Class EPPContactTransferResp
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.contact.EPPContactTransferResp
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPContactTransferResp extends EPPResponse
Represents a <contact:trnData> response toEPPContactTransferCmd
. When a <transfer> query command has been processed successfully, the EPP <resData> element MUST contain a child <contact:trnData> element that identifies the contact namespace and the location of the contact schema. The <contact:trnData> element SHALL contain the following child elements:
-
A <contact:id> element that contains the server-unique identifier for
the queried contact. Use
getId
andsetId
to get and set the element. -
A <contact:trStatus> element that contains the state of the most
recent transfer request. Valid values are "PENDING", "APPROVED",
"REJECTED", "AUTO-APPROVED", "AUTO-REJECTED", and "CANCELLED". Use
getTrStatus
andsetTrStatus
to get and set the element. -
A <contact:reID> element that contains the identifier of the
client that initiated the transfer request. Use
getRequestClient
andsetRequestClient
to get and set the element. -
A <contact:acID> element that contains the identifier of the client
that SHOULD respond to the transfer request. Use
getActionClient
andsetActionClient
to get and set the element. -
A <contact:reDate> element that contains the date and time that the
transfer was requested. Use
getRequestDate
andsetRequestDate
to get and set the element. -
A <contact:acDate> element that contains the date and time of a
required or completed response. For a PENDING request, the value
identifies the date and time by which a response is required before an
automated response action MUST be taken by the server. For all other
status types, the value identifies the date and time when the request was
completed. Use
getActionDate
andsetActionDate
to get and set the element.
- See Also:
EPPContactTransferCmd
, Serialized Form
-
-
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 EPPContactTransferResp()
EPPContactTransferResp
default constructor.EPPContactTransferResp(EPPTransId aTransId, java.lang.String aId)
EPPContactTransferResp
which takes the id of contact.EPPContactTransferResp(EPPTransId aTransId, java.lang.String aId, java.lang.String aStatus)
EPPContactTransferResp
which takes the id of contact.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPContactTransferResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPContactTransferResp
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 theEPPContactTransferResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPContactTransferResp
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.lang.String
getId()
Gets the contact idjava.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPContactTransferResp
.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()
Get transfer status.java.lang.String
getType()
Gets the EPP response type associated withEPPContactTransferResp
.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
setId(java.lang.String aId)
Sets the contact id.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 newTrStatus)
Set transfer status.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, isSuccess, setExtension, setExtensions, setMsgQueue, setResult, setResult, setResult, setResult, setResults, setTransId
-
-
-
-
Constructor Detail
-
EPPContactTransferResp
public EPPContactTransferResp()
EPPContactTransferResp
default constructor. Must call required setter methods before invokingencode
, which include:
-
id -
setId
-
request client -
setRequestClient
-
action client -
setActionClient
-
transfer status -
setTransferStatus
-
request date -
setReqeustDate
-
action date -
setActionDate
-
transaction id -
setTransId
-
id -
-
EPPContactTransferResp
public EPPContactTransferResp(EPPTransId aTransId, java.lang.String aId)
EPPContactTransferResp
which takes the id of contact. All other required attributes need to be set using the setter methods, which include:
-
request client -
setRequestClient
-
action client -
setActionClient
-
transfer status -
setTransferStatus
-
request date -
setReqeustDate
-
action date -
setActionDate
- Parameters:
aTransId
- Transaction Id associated with response.aId
- Contact id
-
request client -
-
EPPContactTransferResp
public EPPContactTransferResp(EPPTransId aTransId, java.lang.String aId, java.lang.String aStatus)
EPPContactTransferResp
which takes the id of contact. All other required attributes need to be set using the setter methods, which include:
-
request client -
setRequestClient
-
action client -
setActionClient
-
transfer status -
setTransferStatus
-
request date -
setReqeustDate
-
action date -
setActionDate
- Parameters:
aTransId
- Transaction Id associated with response.aId
- ContactaStatus
- Transfer status
-
request client -
-
-
Method Detail
-
getType
public java.lang.String getType()
Gets the EPP response type associated withEPPContactTransferResp
.- Overrides:
getType
in classEPPResponse
- Returns:
EPPContactTransferResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPContactTransferResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPContactMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPContactTransferResp
instance.- Overrides:
doEncode
in classEPPResponse
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPContactTransferResp
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPContactTransferResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPContactTransferResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPContactTransferResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPContactTransferResp
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
CloneEPPContactTransferResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPContactTransferResp
- 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.
-
getId
public java.lang.String getId()
Gets the contact id- Returns:
- Contact Id if set;
null
otherwise.
-
setId
public void setId(java.lang.String aId)
Sets the contact id.- Parameters:
aId
- Contact Id
-
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 IdString
-
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 IdString
-
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.
-
getTransferStatus
public java.lang.String getTransferStatus()
Get transfer status. This should be one of theEPPResponse.TRANSFER
constants.- Returns:
- String
-
setTransferStatus
public void setTransferStatus(java.lang.String newTrStatus)
Set transfer status. This should be one of theEPPResponse.TRANSFER
constants.- Parameters:
newTrStatus
- The transfer status String (EPPResponse.TRANSFER
)
-
-