Package com.verisign.epp.codec.contact
Class EPPContactDeleteCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPDeleteCmd
-
- com.verisign.epp.codec.contact.EPPContactDeleteCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPContactDeleteCmd extends EPPDeleteCmd
Represents an EPP Contact <delete> command that allows a client to delete a contact object. In addition to the standard EPP command elements, the <delete> command MUST contain a "contact:delete" element that identifies the contact namespace and the location of the contact schema. The "contact:delete" element SHALL contain the following child elements:
-
A <contact:id> element that contains the server-unique identifier for
the contact to be deleted. Use
getId
andsetId
to get and set the element.
EPPReponse
is the response associated withEPPContactDeleteCmd
.- See Also:
EPPResponse
, 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 EPPContactDeleteCmd()
EPPContactDeleteCmd
default constructor.EPPContactDeleteCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactDeleteCmd
constructor that takes the contact id as an argument.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPContactDeleteCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPContactDeleteCmd
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 theEPPContactDeleteCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPContactDeleteCmd
with this instance.java.lang.String
getId()
Gets the contact id to delete.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPContactDeleteCmd
.void
setId(java.lang.String aId)
Sets the contact id to delete.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.EPPDeleteCmd
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
-
EPPContactDeleteCmd
public EPPContactDeleteCmd()
EPPContactDeleteCmd
default constructor. The id is initialized tonull
. The id must be set before invokingencode
.
-
EPPContactDeleteCmd
public EPPContactDeleteCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactDeleteCmd
constructor that takes the contact id as an argument.- Parameters:
aTransId
- Transaction Id associated with command.aId
- Contact id to delete.
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPContactDeleteCmd
.- 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 theEPPContactDeleteCmd
instance.- Specified by:
doEncode
in classEPPDeleteCmd
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPContactDeleteCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPContactDeleteCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPContactDeleteCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPDeleteCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPContactDeleteCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
getId
public java.lang.String getId()
Gets the contact id to delete.- Returns:
- Contact Id
String
instance if defined;null
otherwise.
-
setId
public void setId(java.lang.String aId)
Sets the contact id to delete.- Parameters:
aId
- Contact Id
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPContactDeleteCmd
with this instance.- Overrides:
equals
in classEPPDeleteCmd
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPContactDeleteCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPContactDeleteCmd
- 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.
-
-