|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPDeleteCmd
public abstract class EPPDeleteCmd
The EPP <delete> command is used to remove an instance of an existing
object. The elements needed to identify an object are object-specific, so
the child elements of the <delete> command are specified using the EPP
extension framework. In addition to the standard EPP command elements, the
<delete> command SHALL contain the following child elements: An
object-specific <obj:delete> element that identifies the object to be
deleted.
EPPDeleteCmd
is an abtract EPP command class that represents a
delete operation. A command mapping delete command extends
EPPDeleteCmd
. For example,
EPPDomainDeleteCmd
is a EPPDeleteCmd
that
implements the Domain Delete Command Mapping.
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 | |
---|---|
EPPDeleteCmd()
Default constructor for EPPDeleteCmd . |
|
EPPDeleteCmd(java.lang.String aTransId)
EPPDeleteCmd that takes all required attributes as
arguments. |
Method Summary | |
---|---|
protected abstract void |
doDecode(org.w3c.dom.Element aElement)
Must be defined by EPPDeleteCmd extensions (Command
Mappings) to decode the attributes to a DOM Element tree. |
protected abstract org.w3c.dom.Element |
doEncode(org.w3c.dom.Document aDocument)
Must be defined by EPPDeleteCmd extensions (Command
Mappings) to encode the attributes to a DOM Element tree. |
protected void |
doGenDecode(org.w3c.dom.Element aElement)
Decodes the EPPDeleteCmd attributes from the
aElement DOM Element tree. |
protected org.w3c.dom.Element |
doGenEncode(org.w3c.dom.Document aDocument)
Encodes a DOM Element tree from the attributes of the EPPDeleteCmd instance. |
boolean |
equals(java.lang.Object aObject)
Compares an instance of EPPDeleteCmd with this instance. |
java.lang.String |
getType()
Gets the EPP command type associated with EPPDeleteCmd . |
Methods inherited from class com.verisign.epp.codec.gen.EPPCommand |
---|
addExtension, clone, decode, encode, getExtension, getExtension, getExtensions, getNamespace, getOp, getTransId, hasExtension, hasExtensions, hasTransId, setExtension, setExtensions, setTransId, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public EPPDeleteCmd()
EPPDeleteCmd
.
public EPPDeleteCmd(java.lang.String aTransId)
EPPDeleteCmd
that takes all required attributes as
arguments. This will call the super
EPPCommand(String)
method to set the transaction id for
the command.
aTransId
- Transaction Id associated with command.Method Detail |
---|
public java.lang.String getType()
EPPDeleteCmd
.
getType
in class EPPCommand
public boolean equals(java.lang.Object aObject)
EPPDeleteCmd
with this instance.
equals
in class EPPCommand
aObject
- Object to compare with.
protected org.w3c.dom.Element doGenEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPDeleteCmd
instance. This method is a member of the
Template Design Pattern. EPPCommand.encode
is a
Template Method and this method is a Primitive
Operation within the Template Method Design Pattern.
doGenEncode
in class EPPCommand
aDocument
- - DOM Document that is being built. Used as an Element
factory.
EPPDeleteCmd
instance.
EPPEncodeException
- Unable to encode EPPDeleteCmd
instance.protected void doGenDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPDeleteCmd
attributes from the
aElement
DOM Element tree. This method is a member of
the Template Design Pattern. EPPCommand.decode
is a
Template Method and this method is a Primitive
Operation within the Template Method Design Pattern.
doGenDecode
in class EPPCommand
aElement
- - Root DOM Element to decode EPPDeleteCmd
from.
EPPDecodeException
- Unable to decode aElementprotected abstract org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPDeleteCmd
extensions (Command
Mappings) to encode the attributes to a DOM Element tree.
doGenEncode
is a Template Method and this
method is a Primitive Operation within the Template Method
Design Pattern.
aDocument
- - DOM Document that is being built. Used as an Element
factory.
EPPEncodeException
- Unable to encode EPPDeleteCmd extension
instance.protected abstract void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPDeleteCmd
extensions (Command
Mappings) to decode the attributes to a DOM Element tree.
doGenDecode
is a Template Method and this
method is a Primitive Operation within the Template Method
Design Pattern.
aElement
- Root DOM Element representing the
EPPDeleteCmd
extension instance.
EPPDecodeException
- Unable to decode aElement
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |