com.neulevel.epp.core.response
Class EppResponseDataCheck

java.lang.Object
  com.neulevel.epp.core.EppEntity
      com.neulevel.epp.core.response.EppResponseData
          com.neulevel.epp.core.response.EppResponseDataCheck

Direct Known Subclasses:

EppResponseDataCheckContact, EppResponseDataCheckDomain, EppResponseDataCheckHost, EppResponseDataCheckSvcsub, EppResponseDataCheckXriAuthority, EppResponseDataCheckXriName, EppResponseDataCheckXriNumber, EppResponseDataCheckXriService

public abstract class EppResponseDataCheck
extends EppResponseData

This EppResponseDataCheck class implements EPP Response Data entity for EPP Command Check.

Version:

$Revision: 1.2 $ $Date: 2006/03/01 01:35:38 $

Author:

Ning Zhang ning.zhang@neustar.com

Field Summary

static java.lang.String	FOUND Status for checking the existance of an object in the registry
protected java.util.HashMap	hashMap A HashMap storing key and value pairs
static java.lang.String	NOT_FOUND Status for checking the existance of an object in the registry
protected java.util.HashMap	reasonHashMap A HashMap storing key and reason pairs
static java.lang.String	UNKNOWN Status for checking the existance of an object in the registry

Constructor Summary

EppResponseDataCheck()

Method Summary

void	add(java.lang.String id, boolean flag) Adds an entry into the HashMap for indicating if the object can be privisioned in the registry or not
void	add(java.lang.String id, boolean flag, java.lang.String reason) Adds an entry into the HashMap for indicating if the object can be privisioned in the registry or not
void	add(java.lang.String id, java.lang.String flag) Adds an entry into the HashMap for indicating if the object exists in the registry or not - for backward compatibility
java.lang.String	check(java.lang.String id) Checks if an object id is in the HashMap - for backward compatibility
protected void	fromXMLCommon(org.w3c.dom.Node root, java.lang.String tag) Converts shared EppResponseDataCheck components from XML format.
java.util.HashMap	getHashMap() Gets the HashMap associated with the result data of the check command - for backward compatibility, alias for getResultHashMap()
java.lang.String	getReason(java.lang.String id) Gets the reason for an object id
java.util.HashMap	getReasonHashMap() Gets the HashMap associated with the reason data of the check command
java.util.HashMap	getResultHashMap() Gets the HashMap associated with the result data of the check command
boolean	isAvailable(java.lang.String id) Checks if an object id is available for provisioning
protected void	toXMLCommon(org.w3c.dom.Document doc, org.w3c.dom.Element body, java.lang.String tag) Converts shared EppResponseDataCheck component into XML elements

Methods inherited from class com.neulevel.epp.core.response.EppResponseData

fromXML, toString

Methods inherited from class com.neulevel.epp.core.EppEntity

toString, toXML

Methods inherited from class java.lang.Object

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

Field Detail

UNKNOWN

public static final java.lang.String UNKNOWN

Status for checking the existance of an object in the registry

See Also:

Constant Field Values

FOUND

public static final java.lang.String FOUND

Status for checking the existance of an object in the registry

See Also:

Constant Field Values

NOT_FOUND

public static final java.lang.String NOT_FOUND

Status for checking the existance of an object in the registry

See Also:

Constant Field Values

hashMap

protected java.util.HashMap hashMap

A HashMap storing key and value pairs

reasonHashMap

protected java.util.HashMap reasonHashMap

A HashMap storing key and reason pairs

Constructor Detail

EppResponseDataCheck

public EppResponseDataCheck()

Method Detail

getHashMap

public java.util.HashMap getHashMap()

Gets the HashMap associated with the result data of the check command - for backward compatibility, alias for getResultHashMap()

getResultHashMap

public java.util.HashMap getResultHashMap()

Gets the HashMap associated with the result data of the check command

getReasonHashMap

public java.util.HashMap getReasonHashMap()

Gets the HashMap associated with the reason data of the check command

add

public void add(java.lang.String id,
                java.lang.String flag)

Adds an entry into the HashMap for indicating if the object exists in the registry or not - for backward compatibility

Parameters:

id - The Id associated with an EPP object, ROID for a contact object, domain name for a domain object, host name for a host object

flag - one of the FOUND, NOT_FOUND, UNKNWON, indicating if the object exists in the registry or not, or the existance is unknown

add

public void add(java.lang.String id,
                boolean flag)

Adds an entry into the HashMap for indicating if the object can be privisioned in the registry or not

Parameters:

id - The Id associated with an EPP object, ROID for a contact object, domain name for a domain object, host name for a host object

flag - a boolean flag that indicates the availability of an object, i.e.can it be provisioned or not.

add

public void add(java.lang.String id,
                boolean flag,
                java.lang.String reason)

Adds an entry into the HashMap for indicating if the object can be privisioned in the registry or not

Parameters:

id - The Id associated with an EPP object, ROID for a contact object, domain name for a domain object, host name for a host object

flag - a boolean flag that indicates the availability of an object, i.e.can it be provisioned or not.

reason - a reason text that provides more details of the status

check

public java.lang.String check(java.lang.String id)

Checks if an object id is in the HashMap - for backward compatibility

Returns:

one of the FOUND, NOT_FOUND, UNKNWON

isAvailable

public boolean isAvailable(java.lang.String id)

Checks if an object id is available for provisioning

getReason

public java.lang.String getReason(java.lang.String id)

Gets the reason for an object id

toXMLCommon

protected void toXMLCommon(org.w3c.dom.Document doc,
                           org.w3c.dom.Element body,
                           java.lang.String tag)

Converts shared EppResponseDataCheck component into XML elements

Parameters:

doc - the XML Document object

body - the XML Element to be attached

tag - the XML tag for the object identifiers

fromXMLCommon

protected void fromXMLCommon(org.w3c.dom.Node root,
                             java.lang.String tag)

Converts shared EppResponseDataCheck components from XML format.

Parameters:

root - root node for the list of shared components

tag - the XML tag for the object identifiers