Package com.verisign.epp.codec.defReg

Class EPPDefRegInfoResp

  • All Implemented Interfaces:
    EPPCodecComponent, EPPMessage, java.io.Serializable, java.lang.Cloneable
    public class EPPDefRegInfoResp
extends EPPResponse
    Represents an EPP DefReg <defReg:infData> response to an EPPDefRegInfoCmd. When an <info> command has been processed successfully, the EPP <resData> element MUST contain a child <defReg:infData> element that identifies the defReg namespace and the location of the defReg schema. The <defReg:infData> element contains the following child elements:

    • A <defReg:name> element that contains name information associated with the defReg object. Use getName and setName to get and set the defReg object.
    • A <defReg:roid> element that contains the Repository Object IDentifier. Use getRoid and setRoid to get and set the Roid.
    • An <defReg:registrant> element that contains the identifier for the human or organizational social information (contact) object to be associated with the defReg object as the object registrant. Use getRegistrant and setRegistrant to get and set the elements.
    • A <defReg:tm> OPTIONAL element that contains trademark information to be associated with the defReg object. Use getTm and setTm to get and set the trademark elements.
    • A <defReg:tmcountry> OPTIONAL element that contains trademark country information to be associated with the defReg object. Use getTmCountry and setTmCountry to get and set the elements.
    • A <defReg:tmdate> OPTIONAL element that contains tradeamark date information to be associated with the defReg object. Use getTmDate and setTmDate to get and set the elements.
    • A <defReg:admincontact> element that contains admincontact information to be associated with the defReg object. Use getAdminContact and setAdminContact to get and set the elements.
    • A <defReg:authInfo> element that contains authorization information to be associated with the defReg object.
    • One or more <defReg:status> elements that contain the current status descriptors associated with the defReg. See the EPPDefRegStatus description for a list of valid status values. Use getStatus and setStatus to get and set the elements.
    • A <defReg:crID> element that contains the identifier of the client that created the defReg name. Use getCreatedBy and setCreatedBy to get and set the element.
    • A <defReg:crDate> element that contains the date and time of defReg creation. Use getCreatedDate and setCreatedDate to get and set the element.
    • A <defReg:exDate> element that contains the date and time identifying the end of the defReg's registration period. Use getExpirationDate and setExpirationDate to get and set the element.
    • A <defReg:upID> element that contains the identifier of the client that last updated the defReg name. This element MUST NOT be present if the defReg has never been modified. Use getLastUpdatedBy and setLastUpdatedBy to get and set the element.
    • A <defReg:upDate> element that contains the date and time of the most recent defReg modification. This element MUST NOT be present if the defReg has never been modified. Use getLastUpdatedDate and setLastUpdatedDate to get and set the element.
    • A <defReg:trDate> elements that contains the date and time of the most recent successful transfer. This element MUST NOT be provided if the defReg has never been transferred. Use getLastTransferDate and setLastTransferDate to get and set the element.
    • An OPTIONAL <defReg:authInfo> element that contains authorization information associated with the defReg object. This element MUST NOT be provided if the querying client is not the current sponsoring client. Use getAuthInfo and setAuthInfo to get and set the elements.


    See Also:
    EPPDefRegInfoCmd, Serialized Form

    • Constructor Detail

      • EPPDefRegInfoResp

        public EPPDefRegInfoResp()
        EPPDefRegInfoResp default constructor. Must call required setter methods before invoking encode, which include:

        • name - setName
        • registrant is set to null
        • period is set to UNSPEC_PERIOD
        • tm is set tonull.
        • tmcountry is set tonull.
        • tmdate is set tonull.
        • admincontact is set tonull.
        • roid - setRoid
        • statuses - setStatuses
        • created by - setCreatedBy
        • created date - setCreatedDate
        • transaction id - setTransId

      • EPPDefRegInfoResp

        public EPPDefRegInfoResp​(EPPTransId aTransId,
                         EPPDefRegName aName,
                         java.lang.String aRoid,
                         java.lang.String aClientId)
        EPPDefRegInfoResp constuctor that takes the required attribute values as parameters. The setter methods of the optional attributes can be called before invoking encode.
        Parameters:
        aTransId - Transaction Id associated with response.
        aName - DefReg name
        aRoid - roid
        aClientId - Expirate date of the defReg

      • EPPDefRegInfoResp

        public EPPDefRegInfoResp​(EPPTransId aTransId,
                         EPPDefRegName aName,
                         java.lang.String aRoid,
                         java.lang.String aRegistrant,
                         java.lang.String aTm,
                         java.lang.String aTmCountry,
                         java.util.Date aTmDate,
                         java.lang.String aAdminContact,
                         java.util.Vector aSomeStatuses,
                         java.lang.String aClientId,
                         java.lang.String aCreatedBy,
                         java.util.Date aCreatedDate,
                         EPPAuthInfo aAuthInfo)
        EPPDefRegInfoResp constuctor that takes the required attribute and most used optional values as parameters. The setter methods of the optional attributes can be called before invoking encode.
        Parameters:
        aTransId - Transaction Id associated with response.
        aName - DefReg name
        aRoid - roid
        aRegistrant - DefReg Registrant
        aTm - DefReg TradeMark
        aTmCountry - DefReg TradeMarkCountry
        aTmDate - DefReg TradeMarkDate
        aAdminContact - DefReg AdminContact
        aSomeStatuses - Current status descriptors associated with the defReg.
        aClientId - Expirate date of the defReg
        aCreatedBy - Client Id of Registrar that created the defReg
        aCreatedDate - Date the defReg was created
        aAuthInfo - DOCUMENT ME!

    • Method Detail

      • getStatuses

        public java.util.Vector getStatuses()
        Get the current associated statuses
        Returns:
        java.util.Vector

      • setStatuses

        public void setStatuses​(java.util.Vector newStatuses)
        Set associated statuses.
        Parameters:
        newStatuses - java.util.Vector

      • getType

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

      • equals

        public boolean equals​(java.lang.Object aObject)
        Compare an instance of EPPDefRegInfoResp 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 EPPDefRegInfoResp.
        Specified by:
        clone in interface EPPCodecComponent
        Overrides:
        clone in class EPPResponse
        Returns:
        clone of EPPDefRegInfoResp
        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 EPPDefRegName getName()
        Gets the defReg name
        Returns:
        DefReg Name if defined; null otherwise.

      • setName

        public void setName​(EPPDefRegName aName)
        Sets the defReg name.
        Parameters:
        aName - DefReg Name

      • getRegistrant

        public java.lang.String getRegistrant()
        Get the registrant informnation.
        Returns:
        DefReg registrant

      • setRegistrant

        public void setRegistrant​(java.lang.String aRegistrant)
        Set the registrant informnation.
        Parameters:
        aRegistrant - DefReg registrant

      • getTm

        public java.lang.String getTm()
        Get the trademark informnation.
        Returns:
        DefReg tradeMark

      • setTm

        public void setTm​(java.lang.String aTm)
        Set the trademark informnation.
        Parameters:
        aTm - DefReg registrant

      • getTmCountry

        public java.lang.String getTmCountry()
        Get the trademark country informnation.
        Returns:
        DefReg trademark country

      • setTmCountry

        public void setTmCountry​(java.lang.String aTmCountry)
        Set the trademark country informnation.
        Parameters:
        aTmCountry - DefReg trademark country

      • getTmDate

        public java.util.Date getTmDate()
        Get the trademark date informnation.
        Returns:
        DefReg trademark date

      • setTmDate

        public void setTmDate​(java.util.Date aTmDate)
        Set the trademark date informnation.
        Parameters:
        aTmDate - DefReg trademark date

      • getAdminContact

        public java.lang.String getAdminContact()
        Get the AdminContact informnation.
        Returns:
        DefReg AdminContact

      • setAdminContact

        public void setAdminContact​(java.lang.String aAdminContact)
        Set the AdminContact informnation.
        Parameters:
        aAdminContact - DefReg AdminContact

      • getAuthInfo

        public EPPAuthInfo getAuthInfo()
        Get authorization information
        Returns:
        EPPAuthInfo

      • setAuthInfo

        public void setAuthInfo​(EPPAuthInfo newAuthInfo)
        Set authorization information
        Parameters:
        newAuthInfo - java.lang.String

      • setClientId

        public void setClientId​(java.lang.String aClientId)
        Sets Client Id that created the defReg.
        Parameters:
        aClientId - Client Id that associated with the defReg.

      • getClientId

        public java.lang.String getClientId()
        Gets Client Id that created the defReg.
        Returns:
        Client Id if defined; null otherwise.

      • getCreatedBy

        public java.lang.String getCreatedBy()
        Gets Create Id that created the defReg.
        Returns:
        Create Id if defined; null otherwise.

      • setCreatedBy

        public void setCreatedBy​(java.lang.String aCreatedBy)
        Sets Client Id that created the defReg.
        Parameters:
        aCreatedBy - Client Id that created the defReg.

      • getCreatedDate

        public java.util.Date getCreatedDate()
        Gets the date and time the defReg was created.
        Returns:
        Date and time the defReg was created if defined; null otherwise.

      • setCreatedDate

        public void setCreatedDate​(java.util.Date aDate)
        Sets the date and time the defReg was created.
        Parameters:
        aDate - Date and time the defReg was created.

      • getExpirationDate

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

      • setExpirationDate

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

      • getLastUpdatedBy

        public java.lang.String getLastUpdatedBy()
        Gets the Client Id that last updated the defReg. This will be null if the defReg has not been updated since creation.
        Returns:
        Client Id that last updated the defReg has been updated; null otherwise.

      • setLastUpdatedBy

        public void setLastUpdatedBy​(java.lang.String aLastUpdatedBy)
        Sets the Client Id that last updated the defReg.
        Parameters:
        aLastUpdatedBy - Client Id String that last updated the defReg.

      • getLastUpdatedDate

        public java.util.Date getLastUpdatedDate()
        Gets the date and time of the last defReg update. This will be null if the defReg has not been updated since creation.
        Returns:
        date and time of the last defReg update if defined; null otherwise.

      • setLastUpdatedDate

        public void setLastUpdatedDate​(java.util.Date aLastUpdatedDate)
        Sets the last date and time the defReg was updated.
        Parameters:
        aLastUpdatedDate - Date and time of the last defReg update.

      • getLastTransferDate

        public java.util.Date getLastTransferDate()
        Gets the date and time of the last successful defReg transfer. This will be null if the defReg has not been successfully transferred since creation.
        Returns:
        date and time of the last successful transfer if defined; null otherwise.

      • setLastTransferDate

        public void setLastTransferDate​(java.util.Date aLastTransferDate)
        Sets the last date and time the defReg was successfully transferred.
        Parameters:
        aLastTransferDate - Date and time of the last succesful transfer

      • getRoid

        public java.lang.String getRoid()
        Get roid.
        Returns:
        java.lang.String

      • setRoid

        public void setRoid​(java.lang.String newRoid)
        Set roid.
        Parameters:
        newRoid - java.lang.String

      • doEncode

        protected org.w3c.dom.Element doEncode​(org.w3c.dom.Document aDocument)
                                throws EPPEncodeException
        Encode a DOM Element tree from the attributes of the EPPDefRegInfoResp 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 EPPDefRegInfoResp instance.
        Throws:
        EPPEncodeException - Unable to encode EPPDefRegInfoResp instance.

      • doDecode

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