|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPRenewCmd
com.verisign.epp.codec.emailFwd.EPPEmailFwdRenewCmd
public class EPPEmailFwdRenewCmd
Represents an EPP EmailFwd <renew> command, which provides a transform
operation that allows a client to extend the validity period of a
emailFwd object. The EPP <renew> command provides a transform
operation that allows a client to extend the validity period of a emailFwd
object. In addition to the standard EPP command elements, the
<renew> command MUST contain a <emailFwd:renew> element that
identifies the emailFwd namespace and the location of the emailFwd schema.
The <emailFwd:renew> element SHALL contain the following child
elements:
getName
and setName
to get and set the
element.
getCurExpDate
and setCurExpDate
to get and set the element.
getPeriod
and
setPeriod
to get and set the element. If return
null
, period has not been specified yet.
EPPEmailFwdRenewResp
,
Serialized FormField Summary |
---|
Fields inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE |
Constructor Summary | |
---|---|
EPPEmailFwdRenewCmd()
Allocates a new EPPEmailFwdRenewCmd with default attribute
values. |
|
EPPEmailFwdRenewCmd(java.lang.String aTransId,
java.lang.String aName,
java.util.Date aCurExpDate)
EPPEmailFwdRenewCmd constructor that takes the emailFwd
name and the current expiration year as arguments. |
|
EPPEmailFwdRenewCmd(java.lang.String aTransId,
java.lang.String aName,
java.util.Date aCurExpDate,
EPPEmailFwdPeriod aPeriod)
EPPEmailFwdRenewCmd constructor that takes all of the
attributes of the renew command as arguments. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPEmailFwdRenewCmd . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Decode the EPPEmailFwdRenewCmd 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 the EPPEmailFwdRenewCmd instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of EPPEmailFwdRenewCmd with this
instance. |
java.util.Date |
getCurExpDate()
Get current expiration date. |
java.lang.String |
getName()
Gets the emailFwd name to renew. |
java.lang.String |
getNamespace()
Gets the EPP command Namespace associated with EPPEmailFwdRenewCmd . |
EPPEmailFwdPeriod |
getPeriod()
Gets the registration period of the renew command in years. |
void |
setCurExpDate(java.util.Date newCurExpDate)
Set current expiration date. |
void |
setName(java.lang.String aName)
Sets the emailFwd name to renew. |
void |
setPeriod(EPPEmailFwdPeriod aPeriod)
Sets the registration period of the renew command in years. |
java.lang.String |
toString()
Implementation of Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
Methods inherited from class com.verisign.epp.codec.gen.EPPRenewCmd |
---|
doGenDecode, doGenEncode, getType |
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
addExtension, decode, encode, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPEmailFwdRenewCmd()
EPPEmailFwdRenewCmd
with default attribute
values. the defaults include the following: null
1 year
null
encode
.
public EPPEmailFwdRenewCmd(java.lang.String aTransId, java.lang.String aName, java.util.Date aCurExpDate)
EPPEmailFwdRenewCmd
constructor that takes the emailFwd
name and the current expiration year as arguments. The period will
default to 1 year.
aTransId
- Transaction Id associated with command.aName
- EmailFwd name to renew.aCurExpDate
- The current expiration date of the emailFwdpublic EPPEmailFwdRenewCmd(java.lang.String aTransId, java.lang.String aName, java.util.Date aCurExpDate, EPPEmailFwdPeriod aPeriod)
EPPEmailFwdRenewCmd
constructor that takes all of the
attributes of the renew command as arguments.
aTransId
- Transaction Id associated with command.aName
- EmailFwd name to renew.aCurExpDate
- The current expiration date of the emailFwd.aPeriod
- Registration period in years.Method Detail |
---|
public java.lang.String getNamespace()
EPPEmailFwdRenewCmd
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
EPPEmailFwdMapFactory.NS
public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- EmailFwd Namepublic boolean equals(java.lang.Object aObject)
EPPEmailFwdRenewCmd
with this
instance.
equals
in class EPPRenewCmd
aObject
- Object to compare with.
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPEmailFwdRenewCmd
.
clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPEmailFwdRenewCmd
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class EPPCommand
String
if successful;
ERROR
otherwise.public java.util.Date getCurExpDate()
public EPPEmailFwdPeriod getPeriod()
public void setCurExpDate(java.util.Date newCurExpDate)
newCurExpDate
- java.util.Datepublic void setPeriod(EPPEmailFwdPeriod aPeriod)
aPeriod
- Registration Period in years.protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPEmailFwdRenewCmd
instance.
doEncode
in class EPPRenewCmd
aDocument
- DOM Document that is being built. Used as an Element
factory.
EPPEmailFwdRenewCmd
instance.
EPPEncodeException
- Unable to encode
EPPEmailFwdRenewCmd
instance.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPEmailFwdRenewCmd
attributes from the aElement
DOM Element tree.
doDecode
in class EPPRenewCmd
aElement
- Root DOM Element to decode
EPPEmailFwdRenewCmd
from.
EPPDecodeException
- Unable to decode aElement
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |