|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.registry.EPPRegistryDomainPeriod
public class EPPRegistryDomainPeriod
Defines the supported registration periods and default periods by command
type. The required "command" attribute defines the command type with sample
values of "create", "renew", and "transfer". The <registry:period>
element contains ONE of the following elements:
getLength()
and
setLength(EPPRegistryMinMaxPeriod)
to get and set this element.getServerDecided()
and
setServerDecided(Boolean)
to get and set this element.
EPPRegistryDomain
,
EPPRegistryMinMaxPeriod
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
ATTR_COMMAND
XML attribute name for the command attribute. |
static java.lang.String |
ELM_NAME
XML Element Name of EPPRegistryDomainPeriod root element. |
static java.lang.String |
ELM_SERVER_DECIDED
XML Element Name of serverDecided attribute. |
static int |
MAX_PERIOD
Maximum period in years as defined in RFC5731 |
static int |
MIN_PERIOD
Maximum period in years as defined in RFC5731 |
Constructor Summary | |
---|---|
EPPRegistryDomainPeriod()
Default constructor. |
|
EPPRegistryDomainPeriod(java.lang.String command,
java.lang.Boolean serverDecided)
Construct an instance of EPPRegistryDomainPeriod with the
following inputs. |
|
EPPRegistryDomainPeriod(java.lang.String command,
java.lang.Integer min,
java.lang.String minUnit,
java.lang.Integer max,
java.lang.String maxUnit,
java.lang.Integer defaultLength,
java.lang.String defaultLengthUnit)
Construct an instance of EPPRegistryDomainPeriod with the
following inputs. |
|
EPPRegistryDomainPeriod(java.lang.String command,
int min,
java.lang.String minUnit,
int max,
java.lang.String maxUnit,
int defaultLength,
java.lang.String defaultLengthUnit)
Construct an instance of EPPRegistryDomainPeriod with the
following inputs. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPRegistryDomainPeriod . |
void |
decode(org.w3c.dom.Element aElement)
Decode the EPPRegistryDomainPeriod 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 EPPRegistryDomainPeriod instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep EPPRegistryDomainPeriod compare. |
java.lang.String |
getCommand()
Get the command type. |
EPPRegistryMinMaxPeriod |
getLength()
Get the length for an EPP domain transform command. |
java.lang.Boolean |
getServerDecided()
Get whether to have server decided expiration date. |
void |
setCommand(java.lang.String command)
Set the command type. |
void |
setLength(EPPRegistryMinMaxPeriod length)
Set the length for an EPP domain transform command. |
void |
setServerDecided(java.lang.Boolean serverDecided)
Set whether to have server decided expiration date. |
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 ELM_NAME
EPPRegistryDomainPeriod
root element.
public static final java.lang.String ELM_SERVER_DECIDED
serverDecided
attribute.
public static final java.lang.String ATTR_COMMAND
command
attribute.
public static final int MAX_PERIOD
public static final int MIN_PERIOD
Constructor Detail |
---|
public EPPRegistryDomainPeriod()
command
- null
length
- null
serverDecided
- Boolean.FALSE
public EPPRegistryDomainPeriod(java.lang.String command, java.lang.Integer min, java.lang.String minUnit, java.lang.Integer max, java.lang.String maxUnit, java.lang.Integer defaultLength, java.lang.String defaultLengthUnit)
EPPRegistryDomainPeriod
with the
following inputs. serverDecided
is set to Boolean.FALSE
:
command
- command typemin
- minimum length numberminUnit
- minimum length unitmax
- maximum length numbermaxUnit
- maximum length unitdefaultLength
- default length numberdefaultLengthUnit
- length unitpublic EPPRegistryDomainPeriod(java.lang.String command, int min, java.lang.String minUnit, int max, java.lang.String maxUnit, int defaultLength, java.lang.String defaultLengthUnit)
EPPRegistryDomainPeriod
with the
following inputs. serverDecided
is set to Boolean.FALSE
:
command
- command typemin
- minimum length numberminUnit
- minimum length unitmax
- maximum length numbermaxUnit
- maximum length unitdefaultLength
- default length numberdefaultLengthUnit
- length unitpublic EPPRegistryDomainPeriod(java.lang.String command, java.lang.Boolean serverDecided)
EPPRegistryDomainPeriod
with the
following inputs. length
is set to null
:
command
- command typeserverDecided
- whether no not to have server decided expiration dateMethod Detail |
---|
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPRegistryDomainPeriod
instance.
encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.
EPPRegistryDomainPeriod
instance.
EPPEncodeException
- - Unable to encode EPPRegistryDomainPeriod
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPRegistryDomainPeriod
attributes from the aElement
DOM Element tree.
decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPRegistryDomainPeriod
from.
EPPDecodeException
- Unable to decode aElementpublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPRegistryDomainPeriod
.
clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPRegistryDomainPeriod
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic boolean equals(java.lang.Object aObject)
EPPRegistryDomainPeriod
compare.
equals
in class java.lang.Object
aObject
- EPPRegistryDomainPeriod
instance to compare with
true
if this object is the same as the aObject argument;
false
otherwisepublic 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.public EPPRegistryMinMaxPeriod getLength()
EPPRegistryMinMaxPeriod
that defines
min/max/default period for a given commandpublic void setLength(EPPRegistryMinMaxPeriod length)
length
- instance of EPPRegistryMinMaxPeriod
that defines
min/max/default period for a given commandpublic java.lang.Boolean getServerDecided()
true
- the registration period is decided by the server
based on the relationship to a related object that MUST have the
same expiration date. false
- the registration period is
specified in the length
attribute.public void setServerDecided(java.lang.Boolean serverDecided)
serverDecided
- true
- the registration period is decided by the
server based on the relationship to a related object that MUST
have the same expiration date. false
- the
registration period is specified in the length
attribute.public java.lang.String getCommand()
String
. Valid values are "create",
"renew" and "transfer".public void setCommand(java.lang.String command)
command
- command type in String
. Valid values are "create",
"renew" and "transfer".
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |