Package com.verisign.epp.codec.emailFwd

Class 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 and setName to get and set the element.
    • An OPTIONAL <emailFwd:add> element that contains attribute values to be added to the emailFwd object. Use getAdd and setAdd to get and set the element.
    • An OPTIONAL <emailFwd:chg> element that contains attribute values to be change to the emailFwd object. Use getChange and setChange to get and set the element.
    • An OPTIONAL <emailFwd:rem> element that contains attribute values to be removed from the emailFwd object. Use getRemove and setRemove to get and set the element.

    EPPReponse is the response associated with EPPEmailFwdUpdateCmd.
    See Also:
    EPPResponse, EPPEmailFwdAddRemove, Serialized Form

    • Constructor Detail

      • EPPEmailFwdUpdateCmd

        public EPPEmailFwdUpdateCmd()
        EPPEmailFwdUpdateCmd default constructor. The name is initialized to null. The name must be set before invoking encode.

      • 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 to null. The name must be set before invoking encode.
        Parameters:
        aName - DOCUMENT ME!

    • Method Detail

      • getKey

        public java.lang.String getKey()
        Gets the key for the emailFwd object, which is the emailFwd name.
        Overrides:
        getKey in class EPPCommand
        Returns:
        The emailFwd name if set; null otherwise.

      • doEncode

        protected org.w3c.dom.Element doEncode​(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException
        Encode a DOM Element tree from the attributes of the EPPEmailFwdUpdateCmd instance.
        Specified by:
        doEncode in class EPPUpdateCmd
        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 encode EPPEmailFwdUpdateCmd instance.

      • doDecode

        protected void doDecode​(org.w3c.dom.Element aElement)
                 throws EPPDecodeException
        Decode the EPPEmailFwdUpdateCmd attributes from the aElement DOM Element tree.
        Specified by:
        doDecode in class EPPUpdateCmd
        Parameters:
        aElement - Root DOM Element to decode EPPEmailFwdUpdateCmd from.
        Throws:
        EPPDecodeException - Unable to decode aElement

      • equals

        public boolean equals​(java.lang.Object aObject)
        Compare an instance of EPPEmailFwdUpdateCmd with this instance.
        Overrides:
        equals in class EPPUpdateCmd
        Parameters:
        aObject - Object to compare with.
        Returns:
        DOCUMENT ME!

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Clone EPPEmailFwdUpdateCmd.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPCommand
        Returns:
        clone of EPPEmailFwdUpdateCmd
        Throws:
        java.lang.CloneNotSupportedException - standard Object.clone exception

      • toString

        public java.lang.String toString()
        Implementation of Object.toString, which will result in an indented XML String representation of the concrete EPPCodecComponent.
        Overrides:
        toString in class EPPCommand
        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.