Package com.verisign.epp.codec.launchpolicy.v01

Class EPPLaunchPolicyPollPolicy

java.lang.Object

com.verisign.epp.codec.launchpolicy.v01.EPPLaunchPolicyPollPolicy

All Implemented Interfaces:

EPPCodecComponent, Serializable, Cloneable

public class EPPLaunchPolicyPollPolicy
extends Object
implements EPPCodecComponent

EPPLaunchPolicyPollPolicy defines the poll messaging policy for the phase. The poll policy contains the following required boolean attributes:

1. intermediateStatus - A boolean value indicating whether the server will insert poll messages, per [RFC5730], for the applicable intermediate statuses, including the "pendingValidation", "validated", "pendingAllocation", and "invalid" statuses, using the <domain:infData> element with the <launch:infData> extension.
2. nonMandatoryInfo - A boolean value indicating whether the server will include non-mandatory information in the <domain:infData> element of the poll message.
3. extensionInfo - A boolean value indicating whether the server will include further extensions that would normally be included in the response to the <domain:info> command, per [RFC5731], in the poll message

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELM_LOCALNAME	XML local name for EPPLaunchPolicyPollPolicy.
static final String	ELM_NAME	XML root tag for EPPLaunchPolicyPollPolicy.

Constructor Summary

Constructors

Constructor	Description
EPPLaunchPolicyPollPolicy()	Default constructor for EPPLaunchPolicyPollPolicy.
EPPLaunchPolicyPollPolicy(Boolean aIntermediateStatus, Boolean aNonMandatoryInfo, Boolean aExtensionInfo)

Method Summary

Modifier and Type	Method	Description
Object	clone()	clone an EPPCodecComponent.
void	decode(Element aElement)	decode a DOM element tree to initialize the instance attributes.
Element	encode(Document aDocument)	encode instance into a DOM element tree.
boolean	equals(Object aObject)	Compare an instance of EPPOrgExt with this instance.
Boolean	getExtensionInfo()	Gets the boolean value indicating whether the server will include further extensions that would normally be included in the response to the <domain:info> command, per [RFC5731], in the poll message.
Boolean	getIntermediateStatus()	Gets the boolean value indicating whether the server will insert poll messages, per [RFC5730], for the applicable intermediate statuses, including the "pendingValidation", "validated", "pendingAllocation", and "invalid" statuses, using the <domain:infData> element with the <launch:infData> extension.
String	getNamespace()	Returns the XML namespace associated with the EPPCodecComponent.
Boolean	getNonMandatoryInfo()	Gets the boolean value indicating whether the server will include non-mandatory information in the <domain:infData> element of the poll message.
void	setExtensionInfo(Boolean aExtensionInfo)	Gets the boolean value indicating whether the server will include further extensions that would normally be included in the response to the <domain:info> command, per [RFC5731], in the poll message.
void	setIntermediateStatus(Boolean aIntermediateStatus)	Sets the boolean value indicating whether the server will insert poll messages, per [RFC5730], for the applicable intermediate statuses, including the "pendingValidation", "validated", "pendingAllocation", and "invalid" statuses, using the <domain:infData> element with the <launch:infData> extension.
void	setNonMandatoryInfo(Boolean aNonMandatoryInfo)	Sets the boolean value indicating whether the server will include non-mandatory information in the <domain:infData> element of the poll message.
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 Details

ELM_LOCALNAME

public static final String ELM_LOCALNAME

XML local name for EPPLaunchPolicyPollPolicy.

See Also:

• Constant Field Values

ELM_NAME

public static final String ELM_NAME

XML root tag for EPPLaunchPolicyPollPolicy.

See Also:

• Constant Field Values

Constructor Details

EPPLaunchPolicyPollPolicy

public EPPLaunchPolicyPollPolicy()

Default constructor for EPPLaunchPolicyPollPolicy. All of the boolean attributes must be set prior to calling encode(Document).

EPPLaunchPolicyPollPolicy

public EPPLaunchPolicyPollPolicy(Boolean aIntermediateStatus,
 Boolean aNonMandatoryInfo,
 Boolean aExtensionInfo)

Parameters:

aIntermediateStatus - Boolean indication of whether the intermediate status poll messages are included if defined

aNonMandatoryInfo - Boolean value indicating whether the server will include non-mandatory information in the <domain:infData> element of the poll message.

aExtensionInfo - Boolean value indicating whether the server will include further extensions that would normally be included in the response to the <domain:info> command, per [RFC5731], in the poll message.

Method Details

encode

public Element encode(Document aDocument)
               throws EPPEncodeException

encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.

Specified by:

encode in interface EPPCodecComponent

Parameters:

aDocument - DOM Document, which acts is an Element factory

Returns:

Element Root element associated with the object

Throws:

EPPEncodeException - Error encoding EPPLaunchPolicyPollPolicy

decode

public void decode(Element aElement)
            throws EPPDecodeException

decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.

Specified by:

decode in interface EPPCodecComponent

Parameters:

aElement - Element to decode

Throws:

EPPDecodeException - Error decoding Element

clone

public Object clone()
             throws CloneNotSupportedException

clone an EPPCodecComponent.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class Object

Returns:

clone of concrete EPPOrgExt

Throws:

CloneNotSupportedException - standard Object.clone exception

toString

public String toString()

Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Overrides:

toString in class Object

Returns:

Indented XML String if successful; ERROR otherwise.

equals

public boolean equals(Object aObject)

Compare an instance of EPPOrgExt with this instance.

Overrides:

equals in class Object

Parameters:

aObject - Object to compare with.

Returns:

true if equal; false otherwise.

getIntermediateStatus

public Boolean getIntermediateStatus()

Gets the boolean value indicating whether the server will insert poll messages, per [RFC5730], for the applicable intermediate statuses, including the "pendingValidation", "validated", "pendingAllocation", and "invalid" statuses, using the <domain:infData> element with the <launch:infData> extension.

Returns:

Boolean indication of whether the intermediate status poll messages are included if defined; null otherwise.

setIntermediateStatus

public void setIntermediateStatus(Boolean aIntermediateStatus)

Sets the boolean value indicating whether the server will insert poll messages, per [RFC5730], for the applicable intermediate statuses, including the "pendingValidation", "validated", "pendingAllocation", and "invalid" statuses, using the <domain:infData> element with the <launch:infData> extension.

Parameters:

aIntermediateStatus - The intermediate status boolean value

getNonMandatoryInfo

public Boolean getNonMandatoryInfo()

Gets the boolean value indicating whether the server will include non-mandatory information in the <domain:infData> element of the poll message.

Returns:

The intermediate status boolean value if defined; null otherwise.

setNonMandatoryInfo

public void setNonMandatoryInfo(Boolean aNonMandatoryInfo)

Sets the boolean value indicating whether the server will include non-mandatory information in the <domain:infData> element of the poll message.

Parameters:

aNonMandatoryInfo - The non-mandatory information boolean value

getExtensionInfo

public Boolean getExtensionInfo()

Gets the boolean value indicating whether the server will include further extensions that would normally be included in the response to the <domain:info> command, per [RFC5731], in the poll message.

Returns:

The extension info boolean value if defined; null otherwise.

setExtensionInfo

public void setExtensionInfo(Boolean aExtensionInfo)

Gets the boolean value indicating whether the server will include further extensions that would normally be included in the response to the <domain:info> command, per [RFC5731], in the poll message.

Parameters:

aExtensionInfo - The extension info boolean value

getNamespace

public String getNamespace()

Returns the XML namespace associated with the EPPCodecComponent.

Specified by:

getNamespace in interface EPPCodecComponent

Returns:

XML namespace for the EPPCodecComponent.