|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.nameWatch.EPPNameWatchPeriod
public class EPPNameWatchPeriod
Represents a nameWatch Period. A nameWatch name object MAY have a specified
validity period. If server policy supports nameWatch object validity
periods, the validity period is defined when a nameWatch object is created,
and it MAY be extended by the EPP <renew> or <transfer>
commands. As a matter of server policy, this specification does not define
actions to be taken upon expiration of a nameWatch object's validity
period.
Validity periods are measured in years or months with the appropriate units
specified using the unit
attribute. Valid values for the
unit
attribute are y
for years and m
for months.
Field Summary | |
---|---|
static java.lang.String |
PERIOD_UNIT_MONTH
Period in Unit Month |
static java.lang.String |
PERIOD_UNIT_YEAR
Period in Unit Year |
Constructor Summary | |
---|---|
EPPNameWatchPeriod()
EPPNameWatchPeriod default constructor. |
|
EPPNameWatchPeriod(int aPeriod)
EPPNameWatchPeriod constructor that takes the nameWatch
period (in unit of year) as an argument |
|
EPPNameWatchPeriod(java.lang.String aPUnit,
int aPeriod)
EPPNameWatchPeriod constructor that takes the nameWatch
period and period unit as an arguments |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPNameWatchPeriod . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPNameWatchPeriod attributes from the aElement DOM Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the EPPNameWatchPeriod instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPNameWatchPeriod compare. |
int |
getPeriod()
Get nameWatch period. |
java.lang.String |
getPUnit()
Get nameWatch period unit. |
boolean |
isPeriodUnspec()
Test whether the period has been specfied: true is
unspecified and false is specified. |
void |
setPeriod(int newPeriod)
Set nameWatch period. |
void |
setPUnit(java.lang.String newPUnit)
Set nameWatch period of un. |
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 java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PERIOD_UNIT_MONTH
public static final java.lang.String PERIOD_UNIT_YEAR
Constructor Detail |
---|
public EPPNameWatchPeriod()
EPPNameWatchPeriod
default constructor. The period is
initialized to unspecified
. The period must be set
before invoking encode
.
public EPPNameWatchPeriod(int aPeriod)
EPPNameWatchPeriod
constructor that takes the nameWatch
period (in unit of year) as an argument
aPeriod
- intpublic EPPNameWatchPeriod(java.lang.String aPUnit, int aPeriod)
EPPNameWatchPeriod
constructor that takes the nameWatch
period and period unit as an arguments
aPUnit
- StringaPeriod
- intMethod Detail |
---|
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPNameWatchPeriod
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPNameWatchPeriod
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
decode
in interface EPPCodecComponent
aElement
- - Root DOM Element to decode EPPNameWatchPeriod from.
EPPDecodeException
- Unable to decode aElementpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
encode
in interface EPPCodecComponent
aDocument
- - DOM Document that is being built. Used as an Element
factory.
EPPEncodeException
- - Unable to encode EPPNameWatchPeriod
instance.public boolean equals(java.lang.Object aObject)
EPPNameWatchPeriod
compare.
equals
in class java.lang.Object
aObject
- EPPNameWatchPeriod
instance to compare with
public int getPeriod()
public java.lang.String getPUnit()
public boolean isPeriodUnspec()
true
is
unspecified and false
is specified.
public void setPeriod(int newPeriod) throws EPPCodecException
newPeriod
- int
EPPCodecException
- DOCUMENT ME!public void setPUnit(java.lang.String newPUnit)
newPUnit
- java.lang.Stringpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class java.lang.Object
String
if successful;
ERROR
otherwise.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |