public class EPPLaunchPolicyPhase extends java.lang.Object implements EPPCodecComponent
EPPLaunchPolicyPhase
represents the policies for a zone phase.Modifier and Type | Class and Description |
---|---|
static class |
EPPLaunchPolicyPhase.CheckForm
Possible check forms supported by the phase.
|
static class |
EPPLaunchPolicyPhase.CreateForm
Possible create forms supported by the phase.
|
static class |
EPPLaunchPolicyPhase.MarkValidation
Possible mark validation models supported by the phase.
|
static class |
EPPLaunchPolicyPhase.Mode
Mode defines how the phase operates, which include the following
possible values:fcfs - In this mode, each domain name is immediately created
and there is no use of an application identifier. |
static class |
EPPLaunchPolicyPhase.Phase
Phase defines the type of phase, which include the following
possible values:preDelegation - Phase when pre-delegation testing is done. |
Modifier and Type | Field and Description |
---|---|
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 |
---|
EPPLaunchPolicyPhase()
EPPLaunchPolicyPhase default constructor. |
EPPLaunchPolicyPhase(EPPLaunchPolicyPhase.Phase aPhase,
java.util.Date aStartDate)
EPPLaunchPolicyPhase constructor that takes the required set of
attributes. |
EPPLaunchPolicyPhase(EPPLaunchPolicyPhase.Phase aPhase,
java.lang.String aName,
EPPLaunchPolicyPhase.Mode aMode,
java.util.Date aStartDate,
java.util.Date aEndDate,
java.lang.Boolean aValidatePhase,
java.util.List<java.lang.String> aValidatorIds,
java.util.List<EPPLaunchPolicyPhaseStatus> aStatuses,
java.lang.Boolean aPendingCreate,
EPPLaunchPolicyPollPolicy aPollPolicy,
java.util.List<EPPLaunchPolicyPhase.MarkValidation> aMarkValidations,
java.lang.Integer aMaxMarks,
java.util.List<java.lang.String> aMarksSupported,
java.util.List<java.lang.String> aSignedMarksSupported,
java.util.List<java.lang.String> aEncodedSignedMarksSupported,
java.util.List<EPPLaunchPolicyPhase.CheckForm> aCheckForms,
java.util.List<EPPLaunchPolicyPhase.CreateForm> aCreateForms,
java.lang.Boolean aCreateValidateType)
EPPLaunchPolicyPhase constructor that takes attributes. |
Modifier and Type | Method and Description |
---|---|
void |
addCheckForm(EPPLaunchPolicyPhase.CheckForm aCheckForm)
Adds a check form to the check form list. which defines the supported
check forms in the phase.
|
void |
addCreateForm(EPPLaunchPolicyPhase.CreateForm aCreateForm)
Adds a create form to the create form list. which defines the supported
create forms in the phase.
|
void |
addEncodedSignedMarkSupported(java.lang.String aEncodedSignedMarkSupported)
Add an encoded signed mark XML namespace to the list of supported encoded
signed mark XML namespaces.
|
void |
addInfoPhase(EPPLaunchPolicyInfoPhase aInfoPhase)
Adds an info phase to the info phase list, which defines the supported
info phase values.
|
void |
addMarkSupported(java.lang.String aMarkSupported)
Add a mark XML namespace to the list of supported mark XML namespaces.
|
void |
addMarkValidation(EPPLaunchPolicyPhase.MarkValidation aMarkValidation)
Adds a mark validation model to the mark validation list. which defines
the supported mark validation models in the phase.
|
void |
addSignedMarkSupported(java.lang.String aSignedMarkSupported)
Add a signed mark XML namespace to the list of supported signed mark XML
namespaces.
|
void |
addStatus(EPPLaunchPolicyPhaseStatus aStatus)
Adds a status to the status list. which defines the supported launch
status values.
|
void |
addValidatorId(java.lang.String aValidatorId)
Add a validator identifier to the list of supported Validator Identifier
values for the phase.
|
java.lang.Object |
clone()
Clone
EPPLaunchPolicyPhase instance. |
void |
decode(org.w3c.dom.Element aElement)
Decode the
EPPLaunchPolicyPhase 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
EPPLaunchPolicyPhase instance. |
boolean |
equals(java.lang.Object aObject)
implements a deep
EPPLaunchPolicyPhase compare. |
java.util.List<EPPLaunchPolicyPhase.CheckForm> |
getCheckForms()
Gets the check form list. which defines the supported check forms in the
phase.
|
java.util.List<EPPLaunchPolicyPhase.CreateForm> |
getCreateForms()
Gets the create form list. which defines the supported create forms in the
phase.
|
java.lang.Boolean |
getCreateValidateType()
Gets the OPTIONAL boolean value that indicates whether the server
validates the OPTIONAL <launch:create> "type" attribute.
|
java.util.List<java.lang.String> |
getEncodedSignedMarksSupported()
Gets the encoded signed marks supported list, which is the list of XML
namespaces of the encoded signed marks that are supported in the phase.
|
java.util.Date |
getEndDate()
Get the OPTIONAL end date and time for the phase.
|
java.util.List<EPPLaunchPolicyInfoPhase> |
getInfoPhases()
Gets the info phase list. which defines the supported info phase values.
|
java.util.List<java.lang.String> |
getMarksSupported()
Gets the marks supported list, which is the list of XML namespaces of the
marks that are supported in the phase.
|
java.util.List<EPPLaunchPolicyPhase.MarkValidation> |
getMarkValidations()
Gets the mark validation list. which defines the supported mark validation
models in the phase.
|
java.lang.Integer |
getMaxMarks()
Gets the OPTIONAL maximum number of marks per domain name for the phase.
|
EPPLaunchPolicyPhase.Mode |
getMode()
Gets the mode value.
|
java.lang.String |
getName()
Gets the OPTIONAL phase name or sub-phase name.
|
java.lang.String |
getNamespace()
Returns the XML namespace associated with the
EPPCodecComponent . |
java.lang.Boolean |
getPendingCreate()
Gets the OPTIONAL boolean value that indicates that the server will place
the Launch Application or the Launch Registration in the "pendingCreate"
status as specified in [RFC5731].
|
EPPLaunchPolicyPhase.Phase |
getPhase()
Gets the phase value.
|
EPPLaunchPolicyPollPolicy |
getPollPolicy()
Gets the poll policy value.
|
java.util.List<java.lang.String> |
getSignedMarksSupported()
Gets the signed marks supported list, which is the list of XML namespaces
of the signed marks that are supported in the phase.
|
java.util.Date |
getStartDate()
Get the start date and time for the phase.
|
java.util.List<EPPLaunchPolicyPhaseStatus> |
getStatuses()
Gets the status list. which defines the supported launch status values.
|
java.lang.Boolean |
getValidatePhase()
Gets the OPTIONAL boolean value that indicates whether the server
validates the phase provided by the client in the <launch:phase>
element.
|
java.util.List<java.lang.String> |
getValidatorIds()
Gets the validator identifier list.
|
boolean |
hasCheckForms()
Is the check form list defined?
|
boolean |
hasCreateForms()
Is the create form list defined?
|
boolean |
hasCreateValidateType()
Is the create validate type flag defined?
|
boolean |
hasEncodedSignedMarksSupported()
Is the encoded signed marks supported list defined?
|
boolean |
hasEndDate()
Is the end date defined?
|
boolean |
hasInfoPhases()
Is the info phase list defined?
|
boolean |
hasMarksSupported()
Is the marks supported list defined?
|
boolean |
hasMarkValidations()
Is the mark validation list defined?
|
boolean |
hasMaxMarks()
Is the max marks defined?
|
boolean |
hasName()
Is the name defined?
|
boolean |
hasPendingCreate()
Is the pending create flag defined?
|
boolean |
hasPhase()
Is the phase defined?
|
boolean |
hasPollPolicy()
Is the poll policy defined?
|
boolean |
hasSignedMarksSupported()
Is the signed marks supported list defined?
|
boolean |
hasStartDate()
Is the start date defined?
|
boolean |
hasStatuses()
Is the status list defined?
|
boolean |
hasValidatePhase()
Is the validate phase flag defined?
|
boolean |
hasValidatorIds()
Is the validator identifier list defined?
|
void |
setCheckForms(java.util.List<EPPLaunchPolicyPhase.CheckForm> aCheckForms)
Sets the check form list. which defines the supported check forms in the
phase.
|
void |
setCreateDate(java.util.Date aStartDate)
Set start date and time for the phase.
|
void |
setCreateForms(java.util.List<EPPLaunchPolicyPhase.CreateForm> aCreateForms)
Sets the create form list. which defines the supported create forms in the
phase.
|
void |
setCreateValidateType(java.lang.Boolean aCreateValidateType)
Sets the OPTIONAL boolean value that indicates whether the server
validates the OPTIONAL <launch:create> "type" attribute.
|
void |
setEncodedSignedMarksSupported(java.util.List<java.lang.String> aEncodedSignedMarksSupported)
Sets the encoded signed marks supported list, which is the list of XML
namespaces of the encoded signed marks that are supported in the phase.
|
void |
setEndDate(java.util.Date aEndDate)
Set end date and time for the phase.
|
void |
setInfoPhases(java.util.List<EPPLaunchPolicyInfoPhase> aInfoPhases)
Sets the info phase list. which defines the supported info phase values.
|
void |
setMarksSupported(java.util.List<java.lang.String> aMarksSupported)
Sets the marks supported list, which is the list of XML namespaces of the
marks that are supported in the phase.
|
void |
setMarkValidations(java.util.List<EPPLaunchPolicyPhase.MarkValidation> aMarkValidations)
Sets the mark validation list. which defines the supported mark validation
models in the phase.
|
void |
setMaxMarks(java.lang.Integer aMaxMarks)
Sets the OPTIONAL maximum number of marks per domain name for the phase.
|
void |
setMode(EPPLaunchPolicyPhase.Mode aMode)
Sets the mode value.
|
void |
setName(java.lang.String aName)
Sets the OPTIONAL phase name or sub-phase name.
|
void |
setPendingCreate(java.lang.Boolean aPendingCreate)
Sets the OPTIONAL boolean flag that indicates that the server will place
the Launch Application or the Launch Registration in the "pendingCreate"
status as specified in [RFC5731].
|
void |
setPhase(EPPLaunchPolicyPhase.Phase aPhase)
Sets the phase value.
|
void |
setPollPolicy(EPPLaunchPolicyPollPolicy aPollPolicy)
Sets the poll policy value.
|
void |
setSignedMarksSupported(java.util.List<java.lang.String> aSignedMarksSupported)
Sets the signed marks supported list, which is the list of XML namespaces
of the signed marks that are supported in the phase.
|
void |
setStatuses(java.util.List<EPPLaunchPolicyPhaseStatus> aStatuses)
Sets the status list. which defines the supported launch status values.
|
void |
setValidatePhase(java.lang.Boolean aValidatePhase)
Sets the OPTIONAL boolean flag that indicates whether the server validates
the phase provided by the client in the <launch:phase> element.
|
void |
setValidatorIds(java.util.List<java.lang.String> aValidatorIds)
Sets the validator identifier list.
|
java.lang.String |
toString()
Implementation of
Object.toString , which will result in an
indented XML String representation of the concrete
EPPCodecComponent . |
void |
validateState()
Validate the state of the
EPPLaunchPolicyPhase instance. |
public static final java.lang.String ELM_LOCALNAME
public static final java.lang.String ELM_NAME
public EPPLaunchPolicyPhase()
EPPLaunchPolicyPhase
default constructor.public EPPLaunchPolicyPhase(EPPLaunchPolicyPhase.Phase aPhase, java.util.Date aStartDate)
EPPLaunchPolicyPhase
constructor that takes the required set of
attributes.aPhase
- The launch phaseaStartDate
- Start date and time for the phase.public EPPLaunchPolicyPhase(EPPLaunchPolicyPhase.Phase aPhase, java.lang.String aName, EPPLaunchPolicyPhase.Mode aMode, java.util.Date aStartDate, java.util.Date aEndDate, java.lang.Boolean aValidatePhase, java.util.List<java.lang.String> aValidatorIds, java.util.List<EPPLaunchPolicyPhaseStatus> aStatuses, java.lang.Boolean aPendingCreate, EPPLaunchPolicyPollPolicy aPollPolicy, java.util.List<EPPLaunchPolicyPhase.MarkValidation> aMarkValidations, java.lang.Integer aMaxMarks, java.util.List<java.lang.String> aMarksSupported, java.util.List<java.lang.String> aSignedMarksSupported, java.util.List<java.lang.String> aEncodedSignedMarksSupported, java.util.List<EPPLaunchPolicyPhase.CheckForm> aCheckForms, java.util.List<EPPLaunchPolicyPhase.CreateForm> aCreateForms, java.lang.Boolean aCreateValidateType)
EPPLaunchPolicyPhase
constructor that takes attributes.aPhase
- The launch phaseaName
- The sub-phase name or the custom name if aPhase
is
EPPLaunchPolicyPhase.Phase.custom
. Set to null
if undefined.aMode
- Phase operation mode. Setting to null
will set the mode
ot the default of EPPLaunchPolicyPhase.Mode.fcfs
.aStartDate
- Start date and time for the phase.aEndDate
- OPTIONAL end date and time for the phase. Set to null
if
undefined.aValidatePhase
- OPTIONAL boolean value that indicates whether the server
validates the phase provided by the client in the
<launch:phase> element. Set to null
if undefined.aValidatorIds
- List of validator identifiers.aStatuses
- List of supported phase statusesaPendingCreate
- OPTIONAL boolean value that indicates that the server will place
the Launch Application or the Launch Registration in the
"pendingCreate" status as specified in [RFC5731]. Set to
null
if undefined.aPollPolicy
- An OPTIONAL element that defines the poll messaging policy for
the phase. Set to null
if undefined.aMarkValidations
- Supported mark validation models. Set to null
if
undefined.aMaxMarks
- OPTIONAL maximum number of marks per domain name for the phase.
Set to {code null} if undefined.aMarksSupported
- Supported mark XML namespaces. Set to null
if undefined.aSignedMarksSupported
- Supported signed mark XML namespaces. Set to null
if
undefined.aEncodedSignedMarksSupported
- Supported encoded signed mark XML namespaces. Set to
null
if undefined.aCheckForms
- Supported check forms. Set to null
if undefined.aCreateForms
- Supported create forms. Set to null
if undefined.aCreateValidateType
- OPTIONAL boolean value that indicates whether the server
validates the OPTIONAL <launch:create> "type" attribute.
Set to null
if undefined.public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPLaunchPolicyPhase
instance.clone
in interface EPPCodecComponent
clone
in class java.lang.Object
EPPLaunchPolicyPhase
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic void validateState() throws EPPCodecException
EPPLaunchPolicyPhase
instance. A valid
state means that all of the required attributes have been set. If
validateState returns without an exception, the state is valid. If the
state is not valid, the EPPCodecException
will contain a
description of the error. throws EPPCodecException State error. This will
contain the name of the attribute that is not valid.EPPCodecException
public org.w3c.dom.Element encode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPLaunchPolicyPhase
instance.encode
in interface EPPCodecComponent
aDocument
- - DOM Document that is being built. Used as an Element factory.EPPLaunchPolicyPhase
instance.EPPEncodeException
- - Unable to encode EPPLaunchPolicyPhase
instance.public void decode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPLaunchPolicyPhase
element aElement DOM Element tree.decode
in interface EPPCodecComponent
aElement
- - Root DOM Element to decode EPPLaunchPolicyPhase
from.EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPLaunchPolicyPhase
compare.equals
in class java.lang.Object
aObject
- EPPLaunchPolicyPhase
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
.public boolean hasPhase()
true
if the phase is defined; false
otherwise.public EPPLaunchPolicyPhase.Phase getPhase()
EPPLaunchPolicyPhase.Phase
enumerated value if set; null
otherwise.public void setPhase(EPPLaunchPolicyPhase.Phase aPhase)
aPhase
- Sets the phase 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
- Phase namepublic EPPLaunchPolicyPhase.Mode getMode()
EPPLaunchPolicyPhase.Mode
enumerated value, with the default value of
EPPLaunchPolicyPhase.Mode.fcfs
.public void setMode(EPPLaunchPolicyPhase.Mode aMode)
aMode
- Sets the phase value. If null
the default value of
EPPLaunchPolicyPhase.Mode.fcfs
.public boolean hasStartDate()
true
if the start date is defined; false
otherwise.public java.util.Date getStartDate()
public void setCreateDate(java.util.Date aStartDate)
aStartDate
- Start date and time for the phase.public boolean hasEndDate()
true
if the start date is defined; false
otherwise.public java.util.Date getEndDate()
null
otherwise.public void setEndDate(java.util.Date aEndDate)
aEndDate
- End date and time for the phase. Set to null
if
undefined.public boolean hasValidatePhase()
true
if the validate phase flag is defined;
false
otherwise.public java.lang.Boolean getValidatePhase()
true
or false
indicating whether the
server validates the phase provided by the client in the
<launch:phase> element if defined; null
otherwise.public void setValidatePhase(java.lang.Boolean aValidatePhase)
aValidatePhase
- true
or false
indicating whether the
server validates the phase provided by the client in the
<launch:phase> element. Set to null
if undefined.public boolean hasValidatorIds()
true
if the validator identifier list is defined;
false
otherwise.public java.util.List<java.lang.String> getValidatorIds()
public void setValidatorIds(java.util.List<java.lang.String> aValidatorIds)
aValidatorIds
- List of validator identifiers.public void addValidatorId(java.lang.String aValidatorId)
aValidatorId
- Validator identifier to the list of supported Validator
Identifier values for the phase.public boolean hasStatuses()
true
if the status list is defined; false
otherwise.public java.util.List<EPPLaunchPolicyPhaseStatus> getStatuses()
public void setStatuses(java.util.List<EPPLaunchPolicyPhaseStatus> aStatuses)
aStatuses
- List of supported launch statusespublic void addStatus(EPPLaunchPolicyPhaseStatus aStatus)
aStatus
- Supported status to add to the supported launch status list.public boolean hasPendingCreate()
true
if the pending create flag is defined;
false
otherwise.public java.lang.Boolean getPendingCreate()
true
or false
indicating that the server
will place the Launch Application or the Launch Registration in
the "pendingCreate" status as specified in [RFC5731] if defined;
null
otherwise.public void setPendingCreate(java.lang.Boolean aPendingCreate)
aPendingCreate
- true
or false
indicating that the
server will place the Launch Application or the Launch
Registration in the "pendingCreate" status as specified in
[RFC5731]. Set to null
if undefined.public boolean hasPollPolicy()
true
if the poll policy is defined; false
otherwise.public EPPLaunchPolicyPollPolicy getPollPolicy()
EPPLaunchPolicyPollPolicy
instance if defined;
null
otherwise.public void setPollPolicy(EPPLaunchPolicyPollPolicy aPollPolicy)
aPollPolicy
- Sets the poll policy value.public boolean hasMarkValidations()
true
if the mark validation is defined; false
otherwise.public java.util.List<EPPLaunchPolicyPhase.MarkValidation> getMarkValidations()
public void setMarkValidations(java.util.List<EPPLaunchPolicyPhase.MarkValidation> aMarkValidations)
aMarkValidations
- List of supported mark validation modelspublic void addMarkValidation(EPPLaunchPolicyPhase.MarkValidation aMarkValidation)
aMarkValidation
- Supported mark validation model to add to the mark validation
list.public boolean hasMaxMarks()
true
if the max marks is defined; false
otherwise.public java.lang.Integer getMaxMarks()
null
otherwise.public void setMaxMarks(java.lang.Integer aMaxMarks)
aMaxMarks
- Maximum number of marks per domain name for the phase. Set to
null
if undefined.public boolean hasMarksSupported()
true
if the marks supported list is defined; false
otherwise.public java.util.List<java.lang.String> getMarksSupported()
public void setMarksSupported(java.util.List<java.lang.String> aMarksSupported)
aMarksSupported
- List of supported mark XML namespacespublic void addMarkSupported(java.lang.String aMarkSupported)
aMarkSupported
- XML namespace of the mark that is supported in the phase.public boolean hasSignedMarksSupported()
true
if the signed marks supported list is defined;
false
otherwise.public java.util.List<java.lang.String> getSignedMarksSupported()
public void setSignedMarksSupported(java.util.List<java.lang.String> aSignedMarksSupported)
aSignedMarksSupported
- List of supported signed mark XML namespacespublic void addSignedMarkSupported(java.lang.String aSignedMarkSupported)
aSignedMarkSupported
- XML namespace of the signed mark that is supported in the phase.public boolean hasEncodedSignedMarksSupported()
true
if the encoded signed marks supported list is
defined; false
otherwise.public java.util.List<java.lang.String> getEncodedSignedMarksSupported()
public void setEncodedSignedMarksSupported(java.util.List<java.lang.String> aEncodedSignedMarksSupported)
aEncodedSignedMarksSupported
- List of supported encoded signed mark XML namespacespublic void addEncodedSignedMarkSupported(java.lang.String aEncodedSignedMarkSupported)
aEncodedSignedMarkSupported
- XML namespace of the signed mark that is supported in the phase.public boolean hasCheckForms()
true
if the check form list is defined; false
otherwise.public java.util.List<EPPLaunchPolicyPhase.CheckForm> getCheckForms()
public void setCheckForms(java.util.List<EPPLaunchPolicyPhase.CheckForm> aCheckForms)
aCheckForms
- List of supported check formspublic void addCheckForm(EPPLaunchPolicyPhase.CheckForm aCheckForm)
aCheckForm
- Supported check form to add to the check form list.public boolean hasInfoPhases()
true
if the info phase list is defined; false
otherwise.public java.util.List<EPPLaunchPolicyInfoPhase> getInfoPhases()
public void setInfoPhases(java.util.List<EPPLaunchPolicyInfoPhase> aInfoPhases)
aInfoPhases
- List of supported info phase values.public void addInfoPhase(EPPLaunchPolicyInfoPhase aInfoPhase)
aStatus
- Supported info phase to add to the supported info phase list.public boolean hasCreateForms()
true
if the create form list is defined; false
otherwise.public java.util.List<EPPLaunchPolicyPhase.CreateForm> getCreateForms()
public void setCreateForms(java.util.List<EPPLaunchPolicyPhase.CreateForm> aCreateForms)
aCreateForms
- List of supported create formspublic void addCreateForm(EPPLaunchPolicyPhase.CreateForm aCreateForm)
aCreateForm
- Supported create form to add to the create form list.public boolean hasCreateValidateType()
true
if the create validate type flag is defined;
false
otherwise.public java.lang.Boolean getCreateValidateType()
true
or false
indicating whether the
server validates the OPTIONAL <launch:create> "type"
attribute. if defined; null
otherwise.public void setCreateValidateType(java.lang.Boolean aCreateValidateType)
aCreateValidateType
- true
or false
indicating whether the
server validates the OPTIONAL <launch:create> "type"
attribute. Set to null
if undefined.Copyright © VeriSign Inc. All Rights Reserved.