|
||||||||||
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
com.verisign.epp.codec.contact.EPPContactUpdateCmd
public class EPPContactUpdateCmd
Represents an EPP Host <update> command. The EPP <update>
command provides a transform operation that allows a client to modify the
attributes of a contact object. In addition to the standard EPP command
elements, the <update> command MUST contain a <contact:update>
element that identifies the contact namespace and the location of the
contact schema. The <contact:update> element SHALL contain the
following child elements:
getId
and
setId
to get and set the element.
getAdd
and setAdd
to get and set the element.
getRemove
and
setRemove
to get and set the element.
getChange
and
setChange
to get and set the element.
EPPReponse
is the response associated with
EPPContactUpdateCmd
.
EPPResponse
,
EPPContactAddChange
,
Serialized FormField 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 | |
---|---|
EPPContactUpdateCmd()
EPPContactUpdateCmd default constructor. |
|
EPPContactUpdateCmd(java.lang.String aTransId,
java.lang.String aId)
EPPContactUpdateCmd constructor. |
|
EPPContactUpdateCmd(java.lang.String aTransId,
java.lang.String aId,
EPPContactAddChange aAdd,
EPPContactAddChange aRemove,
EPPContactAddChange aChange)
EPPContactUpdateCmd constructor that takes the required
attributes as arguments. |
Method Summary | |
---|---|
java.lang.Object |
clone()
Clone EPPContactUpdateCmd . |
protected void |
doDecode(org.w3c.dom.Element aElement)
Decode the EPPContactUpdateCmd 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 EPPContactUpdateCmd instance. |
boolean |
equals(java.lang.Object aObject)
Compare an instance of EPPContactUpdateCmd with this
instance. |
EPPContactAddChange |
getAdd()
Gets the items to add to the contact. |
EPPContactAddChange |
getChange()
Gets the items to change to the contact. |
java.lang.String |
getId()
Get contact id. |
java.lang.String |
getNamespace()
Gets the EPP command Namespace associated with EPPContactUpdateCmd . |
EPPContactAddChange |
getRemove()
Gets the items to remove to the contact. |
void |
setAdd(EPPContactAddChange newAdd)
Sets the items to add to the contact. |
void |
setChange(EPPContactAddChange newChange)
Sets the items to change to the contact. |
void |
setId(java.lang.String newId)
Set contact id. |
void |
setRemove(EPPContactAddChange newRemove)
Sets the items to remove to the contact. |
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.EPPUpdateCmd |
---|
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 |
Constructor Detail |
---|
public EPPContactUpdateCmd()
EPPContactUpdateCmd
default constructor. The name is
initialized to null
. The name must be set before
invoking encode
.
public EPPContactUpdateCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactUpdateCmd
constructor.
aTransId
- Transaction Id associated with the command.aId
- Contact IDpublic EPPContactUpdateCmd(java.lang.String aTransId, java.lang.String aId, EPPContactAddChange aAdd, EPPContactAddChange aRemove, EPPContactAddChange aChange)
EPPContactUpdateCmd
constructor that takes the required
attributes as arguments.
aTransId
- Transaction Id associated with the command.aId
- Contact ID.aAdd
- Attributes to add to the contact. null
if no
additions.aRemove
- Attributes to remove from the contact. null
if no removals.aChange
- Attributes to remove from the contact. null
if no changes.Method Detail |
---|
public java.lang.String getNamespace()
EPPContactUpdateCmd
.
getNamespace
in interface EPPMessage
getNamespace
in class EPPCommand
EPPHostMapFactory.NS
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
EPPContactUpdateCmd
instance.
doEncode
in class EPPUpdateCmd
aDocument
- DOM Document that is being built. Used as an Element
factory.
EPPContactUpdateCmd
instance.
EPPEncodeException
- Unable to encode
EPPContactUpdateCmd
instance.protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
EPPContactUpdateCmd
attributes from the aElement
DOM Element tree.
doDecode
in class EPPUpdateCmd
aElement
- Root DOM Element to decode
EPPContactUpdateCmd
from.
EPPDecodeException
- Unable to decode aElementpublic boolean equals(java.lang.Object aObject)
EPPContactUpdateCmd
with this
instance.
equals
in class EPPUpdateCmd
aObject
- Object to compare with.
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
EPPContactUpdateCmd
.
clone
in interface EPPCodecComponent
clone
in class EPPCommand
EPPContactUpdateCmd
java.lang.CloneNotSupportedException
- standard Object.clone exceptionpublic java.lang.String toString()
Object.toString
, which will result in an
indented XML String
representation of the concrete
EPPCodecComponent
.
toString
in class EPPCommand
String
if successful;
ERROR
otherwise.public EPPContactAddChange getAdd()
null
otherwise.public EPPContactAddChange getChange()
null
otherwise.public java.lang.String getId()
public EPPContactAddChange getRemove()
null
otherwise.public void setAdd(EPPContactAddChange newAdd)
newAdd
- Object that contains the list of elements to add to the
contact.public void setChange(EPPContactAddChange newChange)
newChange
- Object that contains the list of elements to change to
the contact.public void setId(java.lang.String newId)
newId
- Stringpublic void setRemove(EPPContactAddChange newRemove)
newRemove
- Object that contains the list of elements to remove to
the contact.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |