Package com.verisign.epp.codec.fee.v1_0

Class EPPFeeCheck

java.lang.Object
com.verisign.epp.codec.fee.v1_0.EPPFeeCheck
All Implemented Interfaces:
EPPCodecComponent, Serializable, Cloneable
public class EPPFeeCheck extends Object implements EPPCodecComponent
Fee Check Extension that enables a client to pass a command along with optionally the currency, period, and fee class to apply to the objects in the check command.
See Also:

  • Field Details

  • Constructor Details

    • EPPFeeCheck

      public EPPFeeCheck()
      Default constructor for EPPFeeCheck.

    • EPPFeeCheck

      public EPPFeeCheck(EPPFeeCommand aCommand)
      Constructor for EPPFeeCheck that takes a single command.
      Parameters:
      aCommand - Command to check

    • EPPFeeCheck

      public EPPFeeCheck(List<EPPFeeCommand> aCommands)
      Constructor for EPPFeeCheck that takes a list of commands.
      Parameters:
      aCommands - List of commands to check

    • EPPFeeCheck

      public EPPFeeCheck(EPPFeeCommand aCommand, String aCurrency)
      Constructor for EPPFeeCheck that takes a single command attribute and the optional currency.
      Parameters:
      aCommand - Command to check
      aCurrency - OPTIONAL desired currency to return

    • EPPFeeCheck

      public EPPFeeCheck(List<EPPFeeCommand> aCommands, String aCurrency)
      Constructor for EPPFeeCheck that takes a list of commands attribute and the optional currency.
      Parameters:
      aCommands - List of commands to check
      aCurrency - OPTIONAL desired currency to return

  • Method Details

    • hasCommands

      public boolean hasCommands()
      Are the commands defined?
      Returns:
      true if the commands are defined; false otherwise.

    • getCommands

      public List<EPPFeeCommand> getCommands()
      Gets the list of commands if defined.
      Returns:
      List of commands if defined; empty list otherwise.

    • addCommand

      public void addCommand(EPPFeeCommand aCommand)
      Adds a command to the list of commands.
      Parameters:
      aCommand - The command to add.

    • setCommands

      public void setCommands(List<EPPFeeCommand> aCommands)
      Sets the list of commands.
      Parameters:
      aCommands - The commands to set.

    • hasCurrency

      public boolean hasCurrency()
      Is the currency defined?
      Returns:
      true if the currency is defined; false otherwise.

    • getCurrency

      public String getCurrency()
      Gets the currency value.
      Returns:
      Currency if defined; null otherwise.

    • setCurrency

      public void setCurrency(String aCurrency)
      Sets the currency value.
      Parameters:
      aCurrency - Currency value

    • encode

      public Element encode(Document aDocument) throws EPPEncodeException
      Encode instance into a DOM element tree. A DOM Document is passed as an argument and functions as a factory for DOM objects. The root element associated with the instance is created and each instance attribute is appended as a child node.
      Specified by:
      encode in interface EPPCodecComponent
      Parameters:
      aDocument - DOM Document, which acts is an Element factory
      Returns:
      Element Root element associated with the object
      Throws:
      EPPEncodeException - Error encoding EPPFeeCheck

    • decode

      public void decode(Element aElement) throws EPPDecodeException
      Decode a DOM element tree to initialize the instance attributes. The aElement argument represents the root DOM element and is used to traverse the DOM nodes for instance attribute values.
      Specified by:
      decode in interface EPPCodecComponent
      Parameters:
      aElement - Element to decode
      Throws:
      EPPDecodeException - Error decoding Element

    • clone

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

    • equals

      public boolean equals(Object aObject)
      Compare an instance of EPPFeeCheck with this instance.
      Overrides:
      equals in class Object
      Parameters:
      aObject - Object to compare with.
      Returns:
      true if equal; false otherwise.

    • getNamespace

      public String getNamespace()
      Returns the XML namespace associated with the EPPCodecComponent.
      Specified by:
      getNamespace in interface EPPCodecComponent
      Returns:
      XML namespace for the EPPCodecComponent.