Package com.aquima.interactions.communication

Interface IRestUrnArgumentDefinition

All Known Implementing Classes:
RestUrnArgumentDefinition
public interface IRestUrnArgumentDefinition
This interface defines an urn argument of a rest request message.
Since:
9.0
Author:
a.pragt

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAttributeName()
    This method returns the attribute definition of the dynamic value.
    String
    getConstant()
    This method returns the default value of the urn fragment.
    String
    getName()
    This method returns the name of the urn argument.
    IFieldValidationDefinition[]
    getValidations()
    This method returns the validations of the attribute.
    boolean
    isRequired()
    This method returns whether the urn fragment is required or not.

  • Method Details

    • getName

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

    • getConstant

      String getConstant()
      This method returns the default value of the urn fragment. A fragment is either a constant or dynamic. If dynamic this method must return null.
      Returns:
      The constant value or null.

    • getAttributeName

      String getAttributeName()
      This method returns the attribute definition of the dynamic value. A fragment is either a constant or dynamic. If constant this method must return null.
      Returns:
      The attribute definition or null.

    • getValidations

      IFieldValidationDefinition[] getValidations()
      This method returns the validations of the attribute.
      Returns:
      The validation definitions of the attribute, may not be null.

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