Package com.verisign.epp.codec.emailFwd

Class EPPEmailFwdRenewResp

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable
    public class EPPEmailFwdRenewResp
extends EPPResponse
    Represents an EPP EmailFwd <emailFwd:renData> response to a EPPEmailFwdRenewCmd. When a <renew> command has been processed successfully, the EPP <resData> element MUST contain a child <emailFwd:renData> element that identifies the emailFwd namespace and the location of the emailFwd schema. The <emailFwd:name> element contains the following child elements:

    • A <emailFwd:name> element that contains the fully qualified emailFwd name that has been created or whose validity period has been extended. Use getName and setName to get and set the element.
    • An OPTIONAL <emailFwd:exDate> element that contains the end of the emailFwd's validity period. Use getExpirationDate and setExpirationDate to get and set the element.
    See Also:
    EPPEmailFwdRenewCmd, Serialized Form

    • Constructor Detail

      • EPPEmailFwdRenewResp

        public EPPEmailFwdRenewResp()
        EPPEmailFwdRenewResp default constructor. Must call required setter methods before encode. the defaults include the following:

        • name is set to null
        • expiration date is set to null

        The name must be set before invoking encode.

      • EPPEmailFwdRenewResp

        public EPPEmailFwdRenewResp​(EPPTransId aTransId,
                            java.lang.String aName)
        EPPEmailFwdRenewResp constructor that takes the required attribute values as parameters.
        Parameters:
        aTransId - Transaction Id associated with response.
        aName - EmailFwd name

      • EPPEmailFwdRenewResp

        public EPPEmailFwdRenewResp​(EPPTransId aTransId,
                            java.lang.String aName,
                            java.util.Date aExpirationDate)
        EPPEmailFwdRenewResp constructor that takes the required attribute values as parameters.
        Parameters:
        aTransId - transaction Id associated with response.
        aName - emailFwd name
        aExpirationDate - expiration date of the emailFwd

    • Method Detail

      • getType

        public java.lang.String getType()
        Gets the EPP command type associated with EPPEmailFwdRenewResp.
        Overrides:
        getType in class EPPResponse
        Returns:
        EPPEmailFwdRenewResp.ELM_NAME

      • equals

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

      • clone

        public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
        Clone EPPEmailFwdRenewResp.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPResponse
        Returns:
        clone of EPPEmailFwdRenewResp
        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 EPPResponse
        Returns:
        Indented XML String if successful; ERROR otherwise.

      • getName

        public java.lang.String getName()
        Gets the emailFwd name
        Returns:
        EmailFwd Name String instance if defined; null otherwise.

      • setName

        public void setName​(java.lang.String aName)
        Sets the emailFwd name.
        Parameters:
        aName - EmailFwd Name

      • getExpirationDate

        public java.util.Date getExpirationDate()
        Gets the expiration date and time of the emailFwd.
        Returns:
        Expiration date and time of the emailFwd if defined; null otherwise.

      • setExpirationDate

        public void setExpirationDate​(java.util.Date aExpirationDate)
        Sets the expiration date and time of the emailFwd.
        Parameters:
        aExpirationDate - Expiration date and time of the emailFwd.

      • doEncode

        protected org.w3c.dom.Element doEncode​(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException
        Encode a DOM Element tree from the attributes of the EPPEmailFwdRenewResp instance.
        Overrides:
        doEncode in class EPPResponse
        Parameters:
        aDocument - DOM Document that is being built. Used as an Element factory.
        Returns:
        Element Root DOM Element representing the EPPEmailFwdRenewResp instance.
        Throws:
        EPPEncodeException - Unable to encode EPPEmailFwdRenewResp instance.

      • doDecode

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