Package com.verisign.epp.codec.defReg
Class EPPDefRegPeriod
- java.lang.Object
-
- com.verisign.epp.codec.defReg.EPPDefRegPeriod
-
- All Implemented Interfaces:
EPPCodecComponent
,java.io.Serializable
,java.lang.Cloneable
public class EPPDefRegPeriod extends java.lang.Object implements EPPCodecComponent
Represents a defReg Period. A defReg name object MAY have a specified validity period. If server policy supports defReg object validity periods, the validity period is defined when a defReg 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 defReg object's validity period.
Validity periods are measured in years or months with the appropriate units specified using theunit
attribute. Valid values for theunit
attribute arey
for years andm
for months.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
PERIOD_UNIT_MONTH
Period in Unit Monthstatic java.lang.String
PERIOD_UNIT_YEAR
Period in Unit Year
-
Constructor Summary
Constructors Constructor Description EPPDefRegPeriod()
EPPDefRegPeriod
default constructor.EPPDefRegPeriod(int aPeriod)
EPPDefRegPeriod
constructor that takes the defReg period (in unit of year) as an argumentEPPDefRegPeriod(java.lang.String aPUnit, int aPeriod)
EPPDefRegPeriod
constructor that takes the defReg period and period unit as an arguments
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPDefRegPeriod
.void
decode(org.w3c.dom.Element aElement)
Decode the EPPDefRegPeriod 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 EPPDefRegPeriod instance.boolean
equals(java.lang.Object aObject)
implements a deepEPPDefRegPeriod
compare.java.lang.String
getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.int
getPeriod()
Get defReg period.java.lang.String
getPUnit()
Get defReg period unit.boolean
isPeriodUnspec()
Test whether the period has been specfied:true
is unspecified andfalse
is specified.void
setPeriod(int newPeriod)
Set defReg period.void
setPUnit(java.lang.String newPUnit)
Set defReg period of un.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.
-
-
-
Field Detail
-
PERIOD_UNIT_MONTH
public static final java.lang.String PERIOD_UNIT_MONTH
Period in Unit Month- See Also:
- Constant Field Values
-
PERIOD_UNIT_YEAR
public static final java.lang.String PERIOD_UNIT_YEAR
Period in Unit Year- See Also:
- Constant Field Values
-
-
Constructor Detail
-
EPPDefRegPeriod
public EPPDefRegPeriod()
EPPDefRegPeriod
default constructor. The period is initialized tounspecified
. The period must be set before invokingencode
.
-
EPPDefRegPeriod
public EPPDefRegPeriod(int aPeriod)
EPPDefRegPeriod
constructor that takes the defReg period (in unit of year) as an argument- Parameters:
aPeriod
- int
-
EPPDefRegPeriod
public EPPDefRegPeriod(java.lang.String aPUnit, int aPeriod)
EPPDefRegPeriod
constructor that takes the defReg period and period unit as an arguments- Parameters:
aPUnit
- StringaPeriod
- int
-
-
Method Detail
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPDefRegPeriod
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classjava.lang.Object
- Returns:
- clone of
EPPDefRegPeriod
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
decode
public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode the EPPDefRegPeriod attributes from the aElement DOM Element tree.- Specified by:
decode
in interfaceEPPCodecComponent
- Parameters:
aElement
- - Root DOM Element to decode EPPDefRegPeriod from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
encode
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of the EPPDefRegPeriod instance.- Specified by:
encode
in interfaceEPPCodecComponent
- Parameters:
aDocument
- - DOM Document that is being built. Used as an Element factory.- Returns:
- Element - Root DOM Element representing the EPPDefRegPeriod instance.
- Throws:
EPPEncodeException
- - Unable to encode EPPDefRegPeriod instance.
-
equals
public boolean equals(java.lang.Object aObject)
implements a deepEPPDefRegPeriod
compare.- Overrides:
equals
in classjava.lang.Object
- Parameters:
aObject
-EPPDefRegPeriod
instance to compare with- Returns:
- DOCUMENT ME!
-
getPeriod
public int getPeriod()
Get defReg period.- Returns:
- int
-
getPUnit
public java.lang.String getPUnit()
Get defReg period unit.- Returns:
- String
-
isPeriodUnspec
public boolean isPeriodUnspec()
Test whether the period has been specfied:true
is unspecified andfalse
is specified.- Returns:
- boolean
-
setPeriod
public void setPeriod(int newPeriod) throws EPPCodecException
Set defReg period.- Parameters:
newPeriod
- int- Throws:
EPPCodecException
- DOCUMENT ME!
-
setPUnit
public void setPUnit(java.lang.String newPUnit)
Set defReg period of un. Creation date: (5/30/01 11:36:52 AM)- Parameters:
newPUnit
- java.lang.String
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classjava.lang.Object
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
getNamespace
public java.lang.String getNamespace()
Returns the XML namespace associated with theEPPCodecComponent
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Returns:
- XML namespace for the
EPPCodecComponent
.
-
-