Package com.verisign.epp.codec.emailFwd
Class EPPEmailFwdUpdateCmd
- java.lang.Object
-
- com.verisign.epp.codec.gen.EPPCommand
-
- com.verisign.epp.codec.gen.EPPUpdateCmd
-
- com.verisign.epp.codec.emailFwd.EPPEmailFwdUpdateCmd
-
- All Implemented Interfaces:
EPPCodecComponent
,EPPMessage
,java.io.Serializable
,java.lang.Cloneable
public class EPPEmailFwdUpdateCmd extends EPPUpdateCmd
Represents an EPP EmailFwd <update> command. The EPP <update> command provides a transform operation that allows a client to modify the attributes of a emailFwd object. In addition to the standard EPP command elements, the <update> command MUST contain a <emailFwd:update> element that identifies the emailFwd namespace and the location of the emailFwd schema. In addition to The <emailFwd:update> element SHALL contain the following child elements:
-
A <emailFwd:name> element that contains the fully qualified emailFwd
name of the object to be updated. Use
getName
andsetName
to get and set the element. -
An OPTIONAL <emailFwd:add> element that contains attribute values to
be added to the emailFwd object. Use
getAdd
andsetAdd
to get and set the element. -
An OPTIONAL <emailFwd:chg> element that contains attribute values to
be change to the emailFwd object. Use
getChange
andsetChange
to get and set the element. -
An OPTIONAL <emailFwd:rem> element that contains attribute values to
be removed from the emailFwd object. Use
getRemove
andsetRemove
to get and set the element.
EPPReponse
is the response associated withEPPEmailFwdUpdateCmd
.- See Also:
EPPResponse
,EPPEmailFwdAddRemove
, 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 EPPEmailFwdUpdateCmd()
EPPEmailFwdUpdateCmd
default constructor.EPPEmailFwdUpdateCmd(java.lang.String aName)
EPPEmailFwdUpdateCmd
default constructor.EPPEmailFwdUpdateCmd(java.lang.String aTransId, java.lang.String aName, EPPEmailFwdAddRemove aAdd, EPPEmailFwdAddRemove aRemove, EPPEmailFwdAddRemove aChange)
EPPEmailFwdUpdateCmd
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()
CloneEPPEmailFwdUpdateCmd
.protected void
doDecode(org.w3c.dom.Element aElement)
Decode theEPPEmailFwdUpdateCmd
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 theEPPEmailFwdUpdateCmd
instance.boolean
equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdUpdateCmd
with this instance.EPPEmailFwdAddRemove
getAdd()
Gets the items to add to the emailFwd.EPPEmailFwdAddRemove
getChange()
Gets the items to change to the emailFwd.java.lang.String
getName()
Gets the emailFwd name to update.java.lang.String
getNamespace()
Gets the EPP command Namespace associated withEPPEmailFwdUpdateCmd
.EPPEmailFwdAddRemove
getRemove()
Gets the items to remove from the emailFwd.void
setAdd(EPPEmailFwdAddRemove aAdd)
Sets the items to add to the emailFwd.void
setChange(EPPEmailFwdAddRemove newChange)
Sets the items to change to the emailFwd.void
setName(java.lang.String aName)
Sets the emailFwd name to update.void
setRemove(EPPEmailFwdAddRemove aRemove)
Sets the items to remove from the emailFwd.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
-
EPPEmailFwdUpdateCmd
public EPPEmailFwdUpdateCmd()
EPPEmailFwdUpdateCmd
default constructor. The name is initialized tonull
. The name must be set before invokingencode
.
-
EPPEmailFwdUpdateCmd
public EPPEmailFwdUpdateCmd(java.lang.String aTransId, java.lang.String aName, EPPEmailFwdAddRemove aAdd, EPPEmailFwdAddRemove aRemove, EPPEmailFwdAddRemove aChange)
EPPEmailFwdUpdateCmd
constructor that takes the required attributes as arguments.- Parameters:
aTransId
- Transaction Id associated with the command.aName
- EmailFwd name to update.aAdd
- Attributes to add to the emailFwd.null
if no additions.aRemove
- Attributes to remove from the emailFwd.null
if no removals.aChange
- DOCUMENT ME!
-
EPPEmailFwdUpdateCmd
public EPPEmailFwdUpdateCmd(java.lang.String aName)
EPPEmailFwdUpdateCmd
default constructor. The name is initialized tonull
. The name must be set before invokingencode
.- Parameters:
aName
- DOCUMENT ME!
-
-
Method Detail
-
getNamespace
public java.lang.String getNamespace()
Gets the EPP command Namespace associated withEPPEmailFwdUpdateCmd
.- Specified by:
getNamespace
in interfaceEPPCodecComponent
- Specified by:
getNamespace
in interfaceEPPMessage
- Specified by:
getNamespace
in classEPPCommand
- Returns:
EPPEmailFwdMapFactory.NS
-
doEncode
protected org.w3c.dom.Element doEncode(org.w3c.dom.Document aDocument) throws EPPEncodeException
Encode a DOM Element tree from the attributes of theEPPEmailFwdUpdateCmd
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
EPPEmailFwdUpdateCmd
instance. - Throws:
EPPEncodeException
- Unable to encodeEPPEmailFwdUpdateCmd
instance.
-
doDecode
protected void doDecode(org.w3c.dom.Element aElement) throws EPPDecodeException
Decode theEPPEmailFwdUpdateCmd
attributes from the aElement DOM Element tree.- Specified by:
doDecode
in classEPPUpdateCmd
- Parameters:
aElement
- Root DOM Element to decodeEPPEmailFwdUpdateCmd
from.- Throws:
EPPDecodeException
- Unable to decode aElement
-
equals
public boolean equals(java.lang.Object aObject)
Compare an instance ofEPPEmailFwdUpdateCmd
with this instance.- Overrides:
equals
in classEPPUpdateCmd
- Parameters:
aObject
- Object to compare with.- Returns:
- DOCUMENT ME!
-
clone
public java.lang.Object clone() throws java.lang.CloneNotSupportedException
CloneEPPEmailFwdUpdateCmd
.- Specified by:
clone
in interfaceEPPCodecComponent
- Overrides:
clone
in classEPPCommand
- Returns:
- clone of
EPPEmailFwdUpdateCmd
- 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.
-
getName
public java.lang.String getName()
Gets the emailFwd name to update.- Returns:
- EmailFwd Name if defined;
null
otherwise.
-
setName
public void setName(java.lang.String aName)
Sets the emailFwd name to update.- Parameters:
aName
- EmailFwd Name
-
getAdd
public EPPEmailFwdAddRemove getAdd()
Gets the items to add to the emailFwd.- Returns:
- Object that contains the list of elements to add to the emailFwd
if defined;
null
otherwise.
-
setAdd
public void setAdd(EPPEmailFwdAddRemove aAdd)
Sets the items to add to the emailFwd.- Parameters:
aAdd
- Object that contains the list of elements to add to the emailFwd.
-
getRemove
public EPPEmailFwdAddRemove getRemove()
Gets the items to remove from the emailFwd.- Returns:
- Object that contains the list of elements to remove from the
emailFwd if defined;
null
otherwise.
-
setRemove
public void setRemove(EPPEmailFwdAddRemove aRemove)
Sets the items to remove from the emailFwd.- Parameters:
aRemove
- Object that contains the list of elements to remove from the emailFwd.
-
getChange
public EPPEmailFwdAddRemove getChange()
Gets the items to change to the emailFwd.- Returns:
- Object that contains the list of elements to change to the
emailFwd if defined;
null
otherwise.
-
setChange
public void setChange(EPPEmailFwdAddRemove newChange)
Sets the items to change to the emailFwd.- Parameters:
newChange
- Object that contains the list of elements to change to the emailFwdemailFwdemailFwd.
-
-