public class EPPFeeCommand extends java.lang.Object implements EPPCodecComponent
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_CUSTOMNAME
OPTIONAL customName attribute name used when the command is set to
Command.CUSTOM . |
static java.lang.String |
ATTR_NAME
name attribute that is set with the Command value.
|
static java.lang.String |
ATTR_PHASE
OPTIONAL phase attribute name that defines the phase of the command.
|
static java.lang.String |
ATTR_SUBPHASE
OPTIONAL subphase attribute name that defines the sub-phase of the
command.
|
static java.lang.String |
ELM_LOCALNAME
Constant for the phase local name
|
static java.lang.String |
ELM_NAME
Constant for the phase qualified name (prefix and local name)
|
Constructor and Description |
---|
EPPFeeCommand()
Default constructor.
|
EPPFeeCommand(Command aCommand)
Create
EPPFeeCommand instance with a defined command value. |
EPPFeeCommand(Command aCommand,
EPPFeePeriod aPeriod)
Create
EPPFeeCommand instance with a defined command value and period. |
EPPFeeCommand(Command aCommand,
Phase aPhase)
Create
EPPFeeCommand instance with a defined command and
phase value. |
EPPFeeCommand(Command aCommand,
Phase aPhase,
java.lang.String aSubPhase)
Create
EPPFeeCommand instance with a defined command, phase,
and sub-phase value. |
EPPFeeCommand(Command aCommand,
java.lang.String aCustomName)
Create
EPPFeeCommand instance with a defined command value
and custom name value. |
EPPFeeCommand(Command aCommand,
java.lang.String aCustomName,
Phase aPhase,
java.lang.String aSubPhase,
EPPFeePeriod aPeriod)
Create
EPPFeeCommand instance with a defined command value
and custom name value. |
EPPFeeCommand(EPPFeeCommand aCommand)
Instantiate instance using an existing
EPPFeeCommand instance. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPFeeCommand instance. |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPFeeCommand element aElement DOM Element tree. |
org.w3c.dom.Element |
encode(org.w3c.dom.Document aDocument)
Encode a DOM Element tree from the attributes of the
EPPFeeCommand instance. |
boolean |
equals(java.lang.Object aObject)
Implements a deep
EPPFeeCommand compare. |
Command |
getCommand()
Gets the command value.
|
java.lang.String |
getCustomName()
Gets the custom name value.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
EPPFeePeriod |
getPeriod()
Gets the period value.
|
Phase |
getPhase()
Gets the OPTIONAL phase value.
|
java.lang.String |
getSubPhase()
Gets the OPTIONAL sub-phase value.
|
boolean |
hasCommand()
Is the command defined?
|
boolean |
hasCustomName()
Is the custom name defined?
|
boolean |
hasPeriod()
Is the period defined?
|
boolean |
hasPhase()
Is the phase defined?
|
boolean |
hasSubPhase()
Is the sub-phase defined?
|
void |
setCommand(Command aCommand)
Sets the command value.
|
void |
setCustomName(java.lang.String aCustomName)
Sets the custom name value when the command is set to
Command.CUSTOM . |
void |
setPeriod(EPPFeePeriod aPeriod)
Sets the optional period value.
|
void |
setPhase(Phase aPhase)
Sets the OPTIONAL phase value.
|
void |
setSubPhase(java.lang.String aSubPhase)
Sets the OPTIONAL sub-phase value.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
public static final java.lang.String ELM_LOCALNAME
public static final java.lang.String ELM_NAME
public static final java.lang.String ATTR_PHASE
public static final java.lang.String ATTR_SUBPHASE
public static final java.lang.String ATTR_NAME
public static final java.lang.String ATTR_CUSTOMNAME
Command.CUSTOM
.public EPPFeeCommand()
public EPPFeeCommand(Command aCommand)
EPPFeeCommand
instance with a defined command value.aCommand
- Command value.public EPPFeeCommand(Command aCommand, EPPFeePeriod aPeriod)
EPPFeeCommand
instance with a defined command value and period.aCommand
- Command value.aPeriod
- Command periodpublic EPPFeeCommand(Command aCommand, java.lang.String aCustomName)
EPPFeeCommand
instance with a defined command value
and custom name value.aCommand
- Command value, which should be Command.CUSTOM
.aCustomName
- Custom name of the command.public EPPFeeCommand(Command aCommand, Phase aPhase)
EPPFeeCommand
instance with a defined command and
phase value.aCommand
- Command value.aPhase
- Phase value.public EPPFeeCommand(Command aCommand, Phase aPhase, java.lang.String aSubPhase)
EPPFeeCommand
instance with a defined command, phase,
and sub-phase value.aCommand
- Command value.aPhase
- Phase value.aSubPhase
- Sub-phase valuepublic EPPFeeCommand(Command aCommand, java.lang.String aCustomName, Phase aPhase, java.lang.String aSubPhase, EPPFeePeriod aPeriod)
EPPFeeCommand
instance with a defined command value
and custom name value.aCommand
- Command value, which should be Command.CUSTOM
.aCustomName
- Custom name of the command.aPhase
- Phase value.aSubPhase
- Sub-phase valueaStandard
- Standard command fee?aPeriod
- Command periodpublic EPPFeeCommand(EPPFeeCommand aCommand)
EPPFeeCommand
instance. This is equivalent to cloning the EPPFeeCommand
instance.aCommand
- instance to initialize the EPPFeeCommand
instance with.public boolean hasCommand()
true
if the command is defined; false
otherwise.public Command getCommand()
null
otherwise.public void setCommand(Command aCommand)
aCommand
- Command value.public boolean hasCustomName()
true
if the custom name is defined;
false
otherwise.public java.lang.String getCustomName()
null
otherwise.public void setCustomName(java.lang.String aCustomName)
Command.CUSTOM
.aCustomName
- Custom name value.public boolean hasPhase()
true
if the phase is defined; false
otherwise.public Phase getPhase()
null
otherwise.public void setPhase(Phase aPhase)
aPhase
- Phase valuepublic boolean hasSubPhase()
true
if the phase is defined; false
otherwise.public java.lang.String getSubPhase()
null
otherwise.public void setSubPhase(java.lang.String aSubPhase)
aSubPhase
- Sub-phase value.public boolean hasPeriod()
true
if the period is defined; false
otherwise.public EPPFeePeriod getPeriod()
null
otherwise.public void setPeriod(EPPFeePeriod aPeriod)
aPeriod
- Period value. Set to null
to specify no period.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPFeeCommand
instance.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPFeeCommand
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPFeeCommand
element aElement DOM Element tree.decode
in interface EPPCodecComponent
aElement
- - Root DOM Element to decode EPPFeeCommand
from.EPPDecodeException
- Unable to decode aElementpublic org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPFeeCommand
instance.encode
in interface EPPCodecComponent
aDocument
- - DOM Document that is being built. Used as an Element factory.EPPFeeCommand
instance.EPPEncodeException
- - Unable to encode EPPFeeCommand
instance.public boolean equals(java.lang.Object aObject)
EPPFeeCommand
compare.equals
in class java.lang.Object
aObject
- EPPFeeCommand
instance to compare withtrue
if equal; 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 java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.