com.verisign.epp.codec.reseller
Class EPPResellerCheckCmd

java.lang.Object
  com.verisign.epp.codec.gen.EPPCommand
      com.verisign.epp.codec.gen.EPPCheckCmd
          com.verisign.epp.codec.reseller.EPPResellerCheckCmd

All Implemented Interfaces:

EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable

public class EPPResellerCheckCmd
extends EPPCheckCmd

Represents a reseller <check> command that enables checking on the availability of a set of client-specified but server-unique reseller identifiers.

See Also:

EPPResellerCheckResp, Serialized Form

Field Summary

static java.lang.String	ELM_LOCALNAME XML local name for EPPResellerCheckCmd.
static java.lang.String	ELM_NAME XML root tag for EPPResellerCheckCmd.

Fields inherited from class com.verisign.epp.codec.gen.EPPCommand

extensions, OP_APPROVE, OP_CANCEL, OP_QUERY, OP_REJECT, OP_REQUEST, transId, TYPE_CHECK, TYPE_CREATE, TYPE_DELETE, TYPE_INFO, TYPE_LOGIN, TYPE_LOGOUT, TYPE_POLL, TYPE_RENEW, TYPE_TRANSFER, TYPE_UPDATE

Constructor Summary

EPPResellerCheckCmd()
EPPResellerCheckCmd default constructor.

EPPResellerCheckCmd(java.lang.String aTransId)
EPPResellerCheckCmd constructor that only takes the client transaction identifier

EPPResellerCheckCmd(java.lang.String aTransId, java.lang.String aResellerId)
EPPResellerCheckCmd constructor for setting an individual reseller identifier to check.

Method Summary

void	addResellerId(java.lang.String aResellerId) Append a reseller identifier to the list of reseller identifiers to check.
java.lang.Object	clone() Clone EPPResellerCheckCmd.
protected void	doDecode(org.w3c.dom.Element aElement) Decode the EPPResellerCheckCmd attributes from the aElement DOM Element tree.
protected org.w3c.dom.Element	doEncode(org.w3c.dom.Document aDocument) Encode a DOM Element tree from the attributes of the EPPResellerCheckCmd instance.
boolean	equals(java.lang.Object aObject) Compare an instance of EPPResellerCheckCmd with this instance.
java.lang.String	getNamespace() Gets the EPP command Namespace associated with EPPResellerCheckCmd.
java.util.List<java.lang.String>	getResellerIds() Get the list of reseller identifiers to check.
boolean	hasResellerIds() Are any reseller identifiers defined in the list of reseller identifiers?
void	setResellerId(java.lang.String aResellerId) Set an individual reseller identifier to check.
void	setResellerIds(java.util.List<java.lang.String> aResellerIds) Set the list of reseller identifiers to check.
java.lang.String	toString() Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.

Methods inherited from class com.verisign.epp.codec.gen.EPPCheckCmd

doGenDecode, doGenEncode, getType

Methods inherited from class com.verisign.epp.codec.gen.EPPCommand

addExtension, decode, encode, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ELM_LOCALNAME

public static final java.lang.String ELM_LOCALNAME

XML local name for EPPResellerCheckCmd.

See Also:

Constant Field Values

ELM_NAME

public static final java.lang.String ELM_NAME

XML root tag for EPPResellerCheckCmd.

See Also:

Constant Field Values

Constructor Detail

EPPResellerCheckCmd

public EPPResellerCheckCmd()

EPPResellerCheckCmd default constructor.

EPPResellerCheckCmd

public EPPResellerCheckCmd(java.lang.String aTransId)

EPPResellerCheckCmd constructor that only takes the client transaction identifier

Parameters:

aTransId - Transaction Id associated with command.

EPPResellerCheckCmd

public EPPResellerCheckCmd(java.lang.String aTransId,
                           java.lang.String aResellerId)

EPPResellerCheckCmd constructor for setting an individual reseller identifier to check.

Parameters:

aTransId - Transaction Id associated with command.

aResellerId - Reseller identifier to check

Method Detail

getNamespace

public java.lang.String getNamespace()

Gets the EPP command Namespace associated with EPPResellerCheckCmd.

Specified by:

getNamespace in interface EPPMessage

Specified by:

getNamespace in class EPPCommand

Returns:

EPPResellerMapFactory.NS

hasResellerIds

public boolean hasResellerIds()

Are any reseller identifiers defined in the list of reseller identifiers?

Returns:

true if there is at least one reseller identifier defined; false otherwise.

getResellerIds

public java.util.List<java.lang.String> getResellerIds()

Get the list of reseller identifiers to check.

Returns:

List of reseller identifier String's

setResellerIds

public void setResellerIds(java.util.List<java.lang.String> aResellerIds)

Set the list of reseller identifiers to check.

Parameters:

aResellerIds - List of reseller identifier String's

setResellerId

public void setResellerId(java.lang.String aResellerId)

Set an individual reseller identifier to check. This method clears the existing list of reseller identifiers.

Parameters:

aResellerId - Reseller identifier to check

addResellerId

public void addResellerId(java.lang.String aResellerId)

Append a reseller identifier to the list of reseller identifiers to check. This method does NOT clear the existing list of reseller identifiers.

Parameters:

aResellerId - Reseller identifier to check

doEncode

protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException

Encode a DOM Element tree from the attributes of the EPPResellerCheckCmd instance.

Specified by:

doEncode in class EPPCheckCmd

Parameters:

aDocument - DOM Document that is being built. Used as an Element factory.

Returns:

Element Root DOM Element representing the EPPResellerCheckCmd instance.

Throws:

EPPEncodeException - Unable to encode EPPResellerCheckCmd instance.

doDecode

protected void doDecode(org.w3c.dom.Element aElement)
                 throws EPPDecodeException

Decode the EPPResellerCheckCmd attributes from the aElement DOM Element tree.

Specified by:

doDecode in class EPPCheckCmd

Parameters:

aElement - Root DOM Element to decode EPPResellerCheckCmd from.

Throws:

EPPDecodeException - Unable to decode aElement

equals

public boolean equals(java.lang.Object aObject)

Compare an instance of EPPResellerCheckCmd with this instance.

Overrides:

equals in class EPPCheckCmd

Parameters:

aObject - Object to compare with.

Returns:

true if this object is the same as the aObject argument; false otherwise.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone EPPResellerCheckCmd.

Specified by:

clone in interface EPPCodecComponent

Overrides:

clone in class EPPCommand

Returns:

Deep copy clone of EPPResellerCheckCmd

Throws:

java.lang.CloneNotSupportedException - standard Object.clone exception

toString

public java.lang.String toString()

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

Overrides:

toString in class EPPCommand

Returns:

Indented XML String if successful; ERROR otherwise.