Package com.verisign.epp.codec.nameWatch
Class EPPNameWatchTransferResp
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPResponse
-
- com.verisign.epp.codec.nameWatch.EPPNameWatchTransferResp
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPNameWatchTransferResp extends EPPResponse
Represents an EPP NameWatch <nameWatch:transfer-data> response to anEPPNameWatchTransferCmd
. When a <transfer> query command has been processed successfully, the EPP <resData> element MUST contain a child <nameWatch:trnData> element that identifies the nameWatch namespace and the location of the nameWatch schema. The <nameWatch:trnData> element SHALL contain the following child elements:
-
A <nameWatch:roid> element that contains the fully qualified nameWatch
roid used in the query. Use
getRoid
andsetRoid
to get and set the element. -
A <nameWatch: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
getStatus
andsetStatus
with theEPPNameWatchTransferResp.STATUS_
constants to get and set the element. -
A <nameWatch:reID> element that contains the identifier of the
client that initiated the transfer request. Use
getRequestClient
andsetRequestClient
to get and set the element. andsetActionClient
to get and set the element. -
A <nameWatch:reDate> element that contains the date and time that the
transfer was requested. Use
getRequestDate
andsetRequestDate
to get and set the element. -
A <nameWatch:acID> element that contains the identifier of the client
that SHOULD respond to the transfer request. Use
getActionClient
-
A <nameWatch: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. -
An OPTIONAL <nameWatch:exDate> element that contains the end of
the nameWatch's validity period if the <transfer> command caused or
causes a change in the validity period. Use
getExpirationDate
andsetExpirationDate
to get and set the element.
- See Also:
EPPNameWatchTransferCmd
, 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 EPPNameWatchTransferResp()
EPPNameWatchTransferResp
default constructor.EPPNameWatchTransferResp(EPPTransId aTransId, java.lang.String aRoid)
EPPNameWatchTransferResp
which takes the name of nameWatch.EPPNameWatchTransferResp(EPPTransId aTransId, java.lang.String aRoid, java.lang.String aTransferStatus, java.lang.String aRequestClient, java.util.Date aRequestDate, java.lang.String aActionClient, java.util.Date aActionDate)
EPPNameWatchTransferResp
which takes the name of nameWatch.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPNameWatchTransferResp
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPNameWatchTransferResp
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 theEPPNameWatchTransferResp
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPNameWatchTransferResp
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 nameWatch's validity period if the transfer command caused or causes a change in the validity period.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPNameWatchTransferResp
.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
getRoid()
Gets the nameWatch roidjava.lang.String
getTransferStatus()
Gets the state of the most recent transfer request.java.lang.String
getType()
Gets the EPP response type associated withEPPNameWatchTransferResp
.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 nameWatch's validity period if the transfer command caused or causes a change in the validity period.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
setRoid(java.lang.String aRoid)
Sets the nameWatch roid.void
setTransferStatus(java.lang.String aTransferStatus)
Sets the state of the most recent transfer request.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
-
EPPNameWatchTransferResp
public EPPNameWatchTransferResp()
EPPNameWatchTransferResp
default constructor. Must call required setter methods before invokingencode
, which include:
-
transaction id -
setTransId
-
roid -
setRoid
-
transfer status -
setTransferStatus
-
request client -
setRequestClient
-
request date -
setReqeustDate
-
action client -
setActionClient
-
action date -
setActionDate
-
transaction id -
-
EPPNameWatchTransferResp
public EPPNameWatchTransferResp(EPPTransId aTransId, java.lang.String aRoid)
EPPNameWatchTransferResp
which takes the name of nameWatch. All other required attributes need to be set using the setter methods, which include:
-
transfer status -
setTransferStatus
-
request client -
setRequestClient
-
request date -
setReqeustDate
-
action client -
setActionClient
-
action date -
setActionDate
- Parameters:
aTransId
- Transaction Id associated with response.aRoid
- NameWatch roid
-
transfer status -
-
EPPNameWatchTransferResp
public EPPNameWatchTransferResp(EPPTransId aTransId, java.lang.String aRoid, java.lang.String aTransferStatus, java.lang.String aRequestClient, java.util.Date aRequestDate, java.lang.String aActionClient, java.util.Date aActionDate)
EPPNameWatchTransferResp
which takes the name of nameWatch.- Parameters:
aTransId
- DOCUMENT ME!aRoid
- DOCUMENT ME!aTransferStatus
- DOCUMENT ME!aRequestClient
- DOCUMENT ME!aRequestDate
- DOCUMENT ME!aActionClient
- DOCUMENT ME!aActionDate
- DOCUMENT ME!
-
-
Method Detail
-
getType
public java.lang.String getType()
Gets the EPP response type associated withEPPNameWatchTransferResp
.- Overrides:
getType
in classEPPResponse
- Returns:
EPPNameWatchTransferResp.ELM_NAME
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPNameWatchTransferResp
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Overrides:
getNamespace
in classEPPResponse
- Returns:
EPPNameWatchMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPNameWatchTransferResp
instance.- Overrides:
doEncode
in classEPPResponse
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPNameWatchTransferResp
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPNameWatchTransferResp
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPNameWatchTransferResp
attributes from the aElement DOM Element tree.- Overrides:
doDecode
in classEPPResponse
- Parameters:
aElement
- Root DOM Element to decodeEPPNameWatchTransferResp
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPNameWatchTransferResp
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
CloneEPPNameWatchTransferResp
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPResponse
- Returns:
- clone of
EPPNameWatchTransferResp
- 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.
-
getRoid
public java.lang.String getRoid()
Gets the nameWatch roid- Returns:
- NameWatch Roid if set;
null
otherwise.
-
setRoid
public void setRoid(java.lang.String aRoid)
Sets the nameWatch roid.- Parameters:
aRoid
- NameWatch Roid
-
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
-
getTransferStatus
public java.lang.String getTransferStatus()
Gets the state of the most recent transfer request. This should be one of theEPPResponse.TRANSFER
constants.- Returns:
- The transfer status
String
if defined;null
otherwise.
-
setTransferStatus
public void setTransferStatus(java.lang.String aTransferStatus)
Sets the state of the most recent transfer request. This should be one of theEPPResponse.TRANSFER
constants.- Parameters:
aTransferStatus
- The transfer status String (EPPResponse.TRANSFER
)
-
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.
-
getExpirationDate
public java.util.Date getExpirationDate()
Gets the optional attribute that contains the end of the nameWatch's validity period if the transfer command caused or causes a change in the validity period.- Returns:
- Transfer expiration data and time if defined;
null
otherwise.
-
setExpirationDate
public void setExpirationDate(java.util.Date aExpirationDate)
Sets the optional attribute that contains the end of the nameWatch's validity period if the transfer command caused or causes a change in the validity period.- Parameters:
aExpirationDate
- Transfer expiration data and time.
-
-