Package com.verisign.epp.codec.maintenance.v1_0

Class EPPMaintenanceInfoCmd

java.lang.Object
com.verisign.epp.codec.gen.EPPCommand
com.verisign.epp.codec.gen.EPPInfoCmd
com.verisign.epp.codec.maintenance.v1_0.EPPMaintenanceInfoCmd
All Implemented Interfaces:
EPPCodecComponent, EPPMessage, Serializable, Cloneable
public class EPPMaintenanceInfoCmd extends EPPInfoCmd
Command used to used to retrieve registry maintenance information.
See Also:

  • Field Details

  • Constructor Details

    • EPPMaintenanceInfoCmd

      public EPPMaintenanceInfoCmd()
      EPPMaintenanceInfoCmd default constructor.

    • EPPMaintenanceInfoCmd

      public EPPMaintenanceInfoCmd(String aTransId)
      EPPMaintenanceInfoCmd constructor that only takes the client transaction identifier. The infoType is set to InfoType.list.
      Parameters:
      aTransId - Transaction Id associated with command.

    • EPPMaintenanceInfoCmd

      public EPPMaintenanceInfoCmd(String aTransId, String aMaintenanceId)
      EPPMaintenanceInfoCmd constructor that takes the transaction identifier and the maintenance identifier, while will automatically set the infoType to InfoType.id.
      Parameters:
      aTransId - Transaction Id associated with command. Set to null if a client transaction identifier is not desired.
      aMaintenanceId - Maintenance notification identifier to retrieve

  • Method Details

    • getInfoType

      public EPPMaintenanceInfoCmd.InfoType getInfoType()
      Gets the iinfoTypefor the info command.
      Returns:
      the infoType for the info command.

    • setInfoType

      public void setInfoType(EPPMaintenanceInfoCmd.InfoType aInfoType)
      Sets the infoType for the info command. The maintenance notification identifier is used only when the infoType is set to InfoType.id.
      Parameters:
      aInfoType - The infoType for the info command.

    • getMaintenanceId

      public String getMaintenanceId()
      Gets the maintenance identifier.
      Returns:
      The maintenance identifier if defined; null otherwise.

    • setMaintenanceId

      public void setMaintenanceId(String aMaintenanceId)
      Sets the maintenance identifier. When set to a non-null value, the infoType is set to InfoType.id; otherwise infoType is set to InfoType.list
      Parameters:
      aMaintenanceId - The maintenance notification identifier.

    • doEncode

      protected Element doEncode(Document aDocument) throws EPPEncodeException
      Encode a DOM Element tree from the attributes of the EPPMaintenanceInfoCmd instance.
      Specified by:
      doEncode in class EPPInfoCmd
      Parameters:
      aDocument - DOM Document that is being built. Used as an Element factory.
      Returns:
      Element Root DOM Element representing the EPPMaintenanceInfoCmd instance.
      Throws:
      EPPEncodeException - Unable to encode EPPMaintenanceInfoCmd instance.

    • doDecode

      protected void doDecode(Element aElement) throws EPPDecodeException
      Decode the EPPMaintenanceInfoCmd attributes from the aElement DOM Element tree.
      Specified by:
      doDecode in class EPPInfoCmd
      Parameters:
      aElement - Root DOM Element to decode EPPMaintenanceInfoCmd from.
      Throws:
      EPPDecodeException - Unable to decode aElement

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPMaintenanceInfoCmd with this instance.
      Overrides:
      equals in class EPPInfoCmd
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if this object is the same as the aObject argument; false otherwise.

    • clone

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

    • toString

      public 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.

    • getNamespace

      public String getNamespace()
      Gets the EPP command Namespace associated with EPPMaintenanceInfoCmd.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Specified by:
      getNamespace in interface EPPMessage
      Specified by:
      getNamespace in class EPPCommand
      Returns:
      EPPMaintenanceMapFactory.NS

    • getKey

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