public class EPPLaunchPolicyPhaseStatus extends java.lang.Object implements EPPCodecComponent
EPPLaunchPolicyPhaseStatus
defines a supported launch status value.
The EPPLaunchPolicyPhaseStatus.Status
enumeration includes the possible set of status values
with the optional name attribute used when the status is
EPPLaunchPolicyPhaseStatus.Status.custom
.Modifier and Type | Class and Description |
---|---|
static class |
EPPLaunchPolicyPhaseStatus.Status
Possible launch phase statuses used by the
statuses attribute. |
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ATTR_LANG
XML attribute name used for the OPTIONAL
lang attribute. |
static java.lang.String |
ATTR_NAME
XML attribute name used for the OPTIONAL
name attribute. |
static java.lang.String |
ATTR_STATUS
XML attribute name used for the
status attribute. |
static java.lang.String |
DEFAULT_LANG
Default Language -- English "en"
|
static java.lang.String |
ELM_LOCALNAME
Default root element local name
|
static java.lang.String |
ELM_NAME
Constant for the phase qualified name (prefix and local name)
|
Constructor and Description |
---|
EPPLaunchPolicyPhaseStatus()
Default constructor for
EPPLaunchPolicyPhaseStatus . |
EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus)
EPPLaunchPolicyPhaseStatus constructor that takes the required
status attribute value. |
EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus,
java.lang.String aName)
EPPLaunchPolicyPhaseStatus constructor that takes the required
status attribute value along with a custom name attribute. |
EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus,
java.lang.String aName,
java.lang.String aLang,
java.lang.String aDescription)
EPPLaunchPolicyPhaseStatus constructor that takes attribute
values. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
clone()
Clone
EPPLaunchPolicyPhaseStatus . |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPLaunchPolicyPhaseStatus 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
EPPLaunchPolicyPhaseStatus instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPLaunchPolicyPhaseStatus compare. |
java.lang.String |
getDescription()
Gets the status description, which is free form text describing the
rationale for the status.
|
java.lang.String |
getLang()
Gets the language of the status description with the default set to
DEFAULT_LANG . |
java.lang.String |
getName()
Gets the OPTIONAL custom status name.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
protected java.lang.String |
getRootName()
Gets the root element local name.
|
EPPLaunchPolicyPhaseStatus.Status |
getStatus()
Gets the phase status value.
|
boolean |
hasDescription()
Is the description defined?
|
boolean |
hasName()
Is the name defined?
|
boolean |
hasStatus()
Is the status value defined?
|
void |
setDescription(java.lang.String aDesc)
Sets the status description, which is free form text describing the
rationale for the status.
|
void |
setLang(java.lang.String aLang)
Sets the language of the status description with the default set to
DEFAULT_LANG . |
void |
setName(java.lang.String aName)
Sets the OPTIONAL custom status name.
|
void |
setStatus(EPPLaunchPolicyPhaseStatus.Status aStatus)
Sets the phase status 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 DEFAULT_LANG
public static final java.lang.String ELM_NAME
public static final java.lang.String ATTR_STATUS
status
attribute.public static final java.lang.String ATTR_NAME
name
attribute.public static final java.lang.String ATTR_LANG
lang
attribute.public EPPLaunchPolicyPhaseStatus()
EPPLaunchPolicyPhaseStatus
. The
status
attribute must be set.public EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus)
EPPLaunchPolicyPhaseStatus
constructor that takes the required
status
attribute value.aStatus
- Launch phase status valuepublic EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus, java.lang.String aName)
EPPLaunchPolicyPhaseStatus
constructor that takes the required
status
attribute value along with a custom name attribute.aStatus
- Launch phase status valueaName
- Custom status name. Set to null
if undefined.public EPPLaunchPolicyPhaseStatus(EPPLaunchPolicyPhaseStatus.Status aStatus, java.lang.String aName, java.lang.String aLang, java.lang.String aDescription)
EPPLaunchPolicyPhaseStatus
constructor that takes attribute
values.aStatus
- Phase status valueaName
- OPTIONAL custom status name. Set to null
if undefined.aLang
- OPTIONAL language of the status description with a default of
DEFAULT_LANG
. Set to DEFAULT_LANG
or
null
to use the default value.aDescription
- Description of the status rationaleprotected java.lang.String getRootName()
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPLaunchPolicyPhaseStatus
instance.encode
in interface EPPCodecComponent
aDocument
- DOM Document that is being built. Used as an Element factory.EPPLaunchPolicyPhaseStatus
instance.EPPEncodeException
- - Unable to encode EPPLaunchPolicyPhaseStatus
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPLaunchPolicyPhaseStatus
attributes from the aElement
DOM Element tree.decode
in interface EPPCodecComponent
aElement
- Root DOM Element to decode EPPLaunchPolicyPhaseStatus
from.EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPLaunchPolicyPhaseStatus
compare.equals
in class java.lang.Object
aObject
- EPPLaunchPolicyPhaseStatus
instance to compare withtrue
if this object is the same as the aObject argument;
false
otherwisepublic java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPLaunchPolicyPhaseStatus
.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPLaunchPolicyPhaseStatus
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 java.lang.Object
String
if successful; ERROR
otherwise.public boolean hasStatus()
true
if the status is defined; false
otherwise.public EPPLaunchPolicyPhaseStatus.Status getStatus()
null
otherwise.public void setStatus(EPPLaunchPolicyPhaseStatus.Status aStatus)
aStatus
- The phase status value.public boolean hasName()
true
if the name is defined; false
otherwise.public java.lang.String getName()
null
otherwise.public void setName(java.lang.String aName)
aName
- Custom status namepublic java.lang.String getLang()
DEFAULT_LANG
.DEFAULT_LANG
.public void setLang(java.lang.String aLang)
DEFAULT_LANG
.aLang
- Language of description. If set to null
, the value will
be set to the default of DEFAULT_LANG
.public boolean hasDescription()
true
if the description is defined; false
otherwise.public java.lang.String getDescription()
null
otherwise.public void setDescription(java.lang.String aDesc)
aDesc
- Status description. Set to null
if undefined.public java.lang.String getNamespace()
EPPCodecComponent
.getNamespace
in interface EPPCodecComponent
EPPCodecComponent
.Copyright © VeriSign Inc. All Rights Reserved.