|
||||||||||
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.EPPUpdateCmd
public abstract class EPPUpdateCmd
The EPP update command is used to change information associated with an
existing object. The elements needed to identify and modify an object are
object-specific, so the child elements of the update command are specified
using the EPP extension framework. In addition to the standard EPP command
elements, the <update> command SHALL contain the following child
elements: An object-specific "obj:update" element that identifies the
object to be renewed and the elements that are required to modify the
object. Object-specific elements MUST identify values to be added, values
to be removed, or values to be changed.
EPPUpdateCmd
is an abtract EPP command class that represents a
update operation. A command mapping update command extends
EPPUpdateCmd
. For example,
EPPDomainUpdateCmd
is a EPPUpdateCmd
that
implements the Domain Update 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 | |
---|---|
EPPUpdateCmd()
Default constructor for EPPUpdateCmd . |
|
EPPUpdateCmd(java.lang.String aTransId)
EPPUpdateCmd that takes all required attributes as
arguments. |
Method Summary | |
---|---|
protected abstract void |
doDecode(org.w3c.dom.Element aElement)
Must be defined by EPPUpdateCmd 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 EPPUpdateCmd extensions (Command
Mappings) to encode the attributes to a DOM Element tree. |
protected void |
doGenDecode(org.w3c.dom.Element aElement)
Decodes the EPPUpdateCmd 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 EPPUpdateCmd instance. |
boolean |
equals(java.lang.Object aObject)
Compares an instance of EPPUpdateCmd with this instance. |
java.lang.String |
getType()
Gets the EPP command type associated with EPPUpdateCmd . |
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 EPPUpdateCmd()
EPPUpdateCmd
.
public EPPUpdateCmd(java.lang.String aTransId)
EPPUpdateCmd
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()
EPPUpdateCmd
.
getType
in class EPPCommand
public boolean equals(java.lang.Object aObject)
EPPUpdateCmd
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
EPPUpdateCmd
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.
EPPUpdateCmd
instance.
EPPEncodeException
- Unable to encode EPPUpdateCmd
instance.protected void doGenDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPUpdateCmd
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 EPPUpdateCmd
from.
EPPDecodeException
- Unable to decode aElementprotected abstract org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPUpdateCmd
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 EPPUpdateCmd extension
instance.protected abstract void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPUpdateCmd
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
EPPUpdateCmd
extension instance.
EPPDecodeException
- Unable to decode aElement
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |