Package com.verisign.epp.codec.contact
Class EPPContactUpdateCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPUpdateCmd
-
- com.verisign.epp.codec.contact.EPPContactUpdateCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPContactUpdateCmd extends EPPUpdateCmd
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:
- A <contact:id> element that contains the server-unique identifier
of the contact object to be updated. Use
getId
andsetId
to get and set the element. - An OPTIONAL <contact:add> element that contains attribute values to
be added to the host object. Use
getAdd
andsetAdd
to get and set the element. - An OPTIONAL <contact:rem> element that contains attribute values to
be removed from the host object. Use
getRemove
andsetRemove
to get and set the element. - An OPTIONAL <contact:chg> element that contains attribute values to
be changed to the host object. Use
getChange
andsetChange
to get and set the element.
EPPReponse
is the response associated withEPPContactUpdateCmd
.
- See Also:
EPPResponse
,EPPContactAddChange
, 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 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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Object
clone()
CloneEPPContactUpdateCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPContactUpdateCmd
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 theEPPContactUpdateCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPContactUpdateCmd
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()
Gets the contact id.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPContactUpdateCmd
.EPPContactAddChange
getRemove()
Gets the items to remove from the contact.boolean
hasAdd()
Returnstrue
if add exists.boolean
hasChange()
Returnstrue
if change exists.boolean
hasId()
Returnstrue
if id exists.boolean
hasRemove()
Returnstrue
if remove exists.void
setAdd(EPPContactAddChange aAdd)
Sets the items to add to the contact.void
setChange(EPPContactAddChange aChange)
Sets the items to change in the contact.void
setId(java.lang.String aId)
Sets the contact id.void
setRemove(EPPContactAddChange aRemove)
Sets the items to remove from the contact.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.EPPUpdateCmd
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
-
EPPContactUpdateCmd
public EPPContactUpdateCmd()
EPPContactUpdateCmd
default constructor. The name is initialized tonull
. The name must be set before invokingencode
.
-
EPPContactUpdateCmd
public EPPContactUpdateCmd(java.lang.String aTransId, java.lang.String aId)
EPPContactUpdateCmd
constructor.- Parameters:
aTransId
- Transaction Id associated with the command.aId
- Contact ID
-
EPPContactUpdateCmd
public EPPContactUpdateCmd(java.lang.String aTransId, java.lang.String aId, EPPContactAddChange aAdd, EPPContactAddChange aRemove, EPPContactAddChange aChange)
EPPContactUpdateCmd
constructor that takes the required attributes as arguments.- Parameters:
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
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPContactUpdateCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPHostMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPContactUpdateCmd
instance.- Specified by:
doEncode
in classEPPUpdateCmd
- Parameters:
aDocument
- DOM Document that is being built. Used as an Element factory.- Returns:
- Root DOM Element representing the
EPPContactUpdateCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPContactUpdateCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPContactUpdateCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPUpdateCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPContactUpdateCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPContactUpdateCmd
with this instance.- Overrides:
equals
in classEPPUpdateCmd
- Parameters:
aObject
- Object to compare with.- Returns:
true
if equal;false
otherwise
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPContactUpdateCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPContactUpdateCmd
- 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.
-
hasId
public boolean hasId()
Returnstrue
if id exists.- Returns:
true
if id exists; otherwisefalse
.
-
getId
public java.lang.String getId()
Gets the contact id.- Returns:
- Contact id if set;
null
otherwise.
-
setId
public void setId(java.lang.String aId)
Sets the contact id.- Parameters:
aId
- Contact id
-
hasAdd
public boolean hasAdd()
Returnstrue
if add exists.- Returns:
true
if add exists; otherwisefalse
.
-
getAdd
public EPPContactAddChange getAdd()
Gets the items to add to the contact.- Returns:
- Object that contains the list of elements to add to the contact if
defined;
null
otherwise.
-
setAdd
public void setAdd(EPPContactAddChange aAdd)
Sets the items to add to the contact.- Parameters:
aAdd
- Items to add to the contact.
-
hasChange
public boolean hasChange()
Returnstrue
if change exists.- Returns:
true
if change exists; otherwisefalse
.
-
getChange
public EPPContactAddChange getChange()
Gets the items to change to the contact.- Returns:
- Object that contains the list of elements to change to the contact
if defined;
null
otherwise.
-
setChange
public void setChange(EPPContactAddChange aChange)
Sets the items to change in the contact.- Parameters:
aChange
- Items to change in the contact.
-
hasRemove
public boolean hasRemove()
Returnstrue
if remove exists.- Returns:
true
if remove exists; otherwisefalse
.
-
getRemove
public EPPContactAddChange getRemove()
Gets the items to remove from the contact.- Returns:
- Items to remove from the contact if defined;
null
otherwise.
-
setRemove
public void setRemove(EPPContactAddChange aRemove)
Sets the items to remove from the contact.- Parameters:
aRemove
- Items to remove from the contact.
-
-