com.ausregistry.jtoolkit2.se.price

Class DomainCheckPriceResponseExtension

java.lang.Object

com.ausregistry.jtoolkit2.se.ResponseExtension

com.ausregistry.jtoolkit2.se.price.DomainCheckPriceResponseExtension

All Implemented Interfaces:

java.io.Serializable

public class DomainCheckPriceResponseExtension
extends ResponseExtension

Representation of the EPP Domain Check response extension for Pricing Check aspect of the Domain Name Check Pricing extension.

Use this to access "period", "create" and "renew" fees, and "reason" pricing information for domains as provided in an extension to the EPP Domain Check response. Such a service element is sent by a compliant EPP server in response to a valid Domain Check command with the Pricing Check extension.

For flexibility, this implementation extracts the data from the response using XPath queries, the expressions for which are defined statically.

See Also:

DomainCheckPricingCommandExtension, Domain Name Check Pricing Extension Mapping for the Extensible Provisioning Protocol (EPP), Serialized Form

Field Summary

Fields inherited from class com.ausregistry.jtoolkit2.se.ResponseExtension

CHK_DATA, CREATE, DATA, EXTENSION_EXPR, INFO, RENEW, TRANSFER, UPDATE

Constructor Summary

Constructors

Constructor and Description
DomainCheckPriceResponseExtension()

Method Summary

Modifier and Type	Method and Description
void	fromXML(XMLDocument xmlDoc) Initialises the instance from the given XML document.
java.math.BigDecimal	getCreatePrice(java.lang.Long index)
java.math.BigDecimal	getCreatePrice(java.lang.String domainName)
Period	getPeriod(long index)
Period	getPeriod(java.lang.String domainName)
java.lang.String	getReason(long index)
java.lang.String	getReason(java.lang.String domainName)
java.math.BigDecimal	getRenewPrice(java.lang.Long index)
java.math.BigDecimal	getRenewPrice(java.lang.String domainName)
boolean	isInitialised() Indicates whether fromXML() completed successfully and the extension was successfully initialised from the EPP response.
java.lang.Boolean	isPremium(long index)
java.lang.Boolean	isPremium(java.lang.String domainName)

Methods inherited from class com.ausregistry.jtoolkit2.se.ResponseExtension

replaceResponseType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DomainCheckPriceResponseExtension

public DomainCheckPriceResponseExtension()

Method Detail

fromXML

public final void fromXML(XMLDocument xmlDoc)
                   throws javax.xml.xpath.XPathExpressionException

Description copied from class: ResponseExtension

Initialises the instance from the given XML document.

Specified by:

fromXML in class ResponseExtension

Parameters:

xmlDoc - the XML to be processed

Throws:

javax.xml.xpath.XPathExpressionException

isInitialised

public boolean isInitialised()

Description copied from class: ResponseExtension

Indicates whether fromXML() completed successfully and the extension was successfully initialised from the EPP response.

Specified by:

isInitialised in class ResponseExtension

Returns:

true if the extension has been initialised, else false.

isPremium

public final java.lang.Boolean isPremium(java.lang.String domainName)

Parameters:

domainName - domain name to be checked

Returns:

true if premium, false if not premium for domain if exists otherwise null

getPeriod

public final Period getPeriod(java.lang.String domainName)

Parameters:

domainName - domain name to be checked

Returns:

period that the prices relate to for domain if exists otherwise null

getCreatePrice

public final java.math.BigDecimal getCreatePrice(java.lang.String domainName)

Parameters:

domainName - domain name to be checked

Returns:

create price for domain if exists otherwise null

getRenewPrice

public final java.math.BigDecimal getRenewPrice(java.lang.String domainName)

Parameters:

domainName - domain name to be checked

Returns:

renew price for domain if exists otherwise null

getReason

public final java.lang.String getReason(java.lang.String domainName)

Parameters:

domainName - domain name to be checked

Returns:

reason message with extra information for domain if exists otherwise null

isPremium

public final java.lang.Boolean isPremium(long index)

Parameters:

index - the index of domain to be checked

Returns:

true if premium, false if not premium for domain if exists otherwise null

getPeriod

public final Period getPeriod(long index)

Parameters:

index - the index of domain to be checked

Returns:

period that the prices relate to for domain if exists otherwise null

getCreatePrice

public final java.math.BigDecimal getCreatePrice(java.lang.Long index)

Parameters:

index - the index of domain to be checked

Returns:

create price for domain if exists otherwise null

getRenewPrice

public final java.math.BigDecimal getRenewPrice(java.lang.Long index)

Parameters:

index - the index of domain to be checked

Returns:

renew price for domain if exists otherwise null

getReason

public final java.lang.String getReason(long index)

Parameters:

index - the index of domain to be checked

Returns:

reason message with extra information for domain if exists otherwise null