Package com.aquima.interactions.communication.ds

Interface IRestUrnArgumentDS

All Known Implementing Classes:
ReportingRestUrnArgumentDS, XmlRestUrnArgumentDS, XmlRestUrnArgumentDS
public interface IRestUrnArgumentDS
This interface defines an urn argument of a rest request message.
Since:
9.0
Author:
Arjan Pragt

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Category
    CATEGORY
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeName()
    This method returns the attribute name of the fragment.
    String
    getConstant()
    This method returns the constant value of the fragment.
    String
    getName()
    This method returns the name of the argument, may not be null.
    boolean
    isRequired()
    This method returns whether the urn fragment is required or not.
    void
    iterateValidations(IFieldValidationVisitor visitor)
    This method iterates about the validations of the argument.

  • Field Details

    • CATEGORY

      static final Category CATEGORY

  • Method Details

    • getName

      String getName()
      This method returns the name of the argument, may not be null.
      Returns:
      The name of the argument.

    • getConstant

      String getConstant()
      This method returns the constant value of the fragment. Either this method may return a value or the attributename, otherwise null.
      Returns:
      The constant value of the fragment.

    • getAttributeName

      String getAttributeName()
      This method returns the attribute name of the fragment. Either this method may return a value or the attributename, otherwise null.
      Returns:
      The attributename representing the value of the fragment.

    • isRequired

      boolean isRequired()
      This method returns whether the urn fragment is required or not. The default value is true.
      Returns:
      If the argument is required, defaults to true.

    • iterateValidations

      void iterateValidations(IFieldValidationVisitor visitor)
      This method iterates about the validations of the argument.
      Parameters:
      visitor - The visitor accepting the validations.
      Throws:
      InitializationException - This exception is thrown when the FieldValidation could not be initialized with the provided data source.