Package com.verisign.epp.codec.contact
Class EPPContactCheckCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPCheckCmd
-
- com.verisign.epp.codec.contact.EPPContactCheckCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPContactCheckCmd extends EPPCheckCmd
Represents an EPP Contact <check> command, which is used to determine if a contact id is known to the server. In addition to the standard EPP command elements, the <check> command MUST contain a <contact:check> element that identifies the contact namespace and the location of the contact schema. The <contact:check> element MUST contain the following child elements:
-
One or more <contact:id> elements. The contact id is the the
server-unique identifier for the contact. Use
getIds
andsetIds
to get and set the elements. UsesetId
to set an individual id.
EPPContactCheckResp
is the concreteEPPReponse
associated withEPPContactCheckCmd
.- See Also:
EPPContactCheckResp
, Serialized Form
-
-
Field Summary
-
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
Constructors Constructor Description EPPContactCheckCmd()
EPPContactCheckCmd
default constructor.EPPContactCheckCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactCheckCmd
constructor that will check an individual contact id.EPPContactCheckCmd(java.lang.String aTransId, java.util.Vector someIds)
EPPContactCheckCmd
constructor that will check a list of contact ids.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPContactCheckCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPContactCheckCmd
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 theEPPContactCheckCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPContactCheckCmd
with this instance.java.util.Vector
getIds()
Gets contact ids to check.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPContactCheckCmd
.void
setId(java.lang.String aId)
Sets contact id to check.void
setIds(java.util.Vector someIds)
Sets contact ids to check.java.lang.String
toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.-
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, findDuplicateExtNamespaces, findExtNamespaces, findExtNamespaceSuffixes, findUnsupportedExtNamespaces, findUnsupportedExtNamespaceSuffixes, getExtension, getExtension, getExtensions, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId
-
-
-
-
Constructor Detail
-
EPPContactCheckCmd
public EPPContactCheckCmd()
EPPContactCheckCmd
default constructor. It will set the ids attribute to an emptyVector
.
-
EPPContactCheckCmd
public EPPContactCheckCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactCheckCmd
constructor that will check an individual contact id.- Parameters:
aTransId
- Transaction Id associated with command.aId
- Contact id to check
-
EPPContactCheckCmd
public EPPContactCheckCmd(java.lang.String aTransId, java.util.Vector someIds)
EPPContactCheckCmd
constructor that will check a list of contact ids.- Parameters:
aTransId
- Transaction Id associated with command.someIds
-Vector
of contact idString
's.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPContactCheckCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPContactMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPContactCheckCmd
instance.- Specified by:
doEncode
in classEPPCheckCmd
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Element Root DOM Element representing the
EPPContactCheckCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPContactCheckCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPContactCheckCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPCheckCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPContactCheckCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPContactCheckCmd
with this instance.- Overrides:
equals
in classEPPCheckCmd
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPContactCheckCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPContactCheckCmd
- Throws:
java.lang.CloneNotSupportedException
- standard Object.clone exception
-
toString
public java.lang.String toString()
Implementation ofObject.toString
, which will result in an indented XMLString
representation of the concreteEPPCodecComponent
.- Overrides:
toString
in classEPPCommand
- Returns:
- Indented XML
String
if successful;ERROR
otherwise.
-
setId
public void setId(java.lang.String aId)
Sets contact id to check.- Parameters:
aId
- Id to check.
-
getIds
public java.util.Vector getIds()
Gets contact ids to check.- Returns:
Vector
of contact idString
's.
-
setIds
public void setIds(java.util.Vector someIds)
Sets contact ids to check.- Parameters:
someIds
- Ids to check.
-
-