Package com.aquima.interactions.communication.ds

Interface IRestOperationDS

All Known Implementing Classes:
ReportingRestOperationDS, XmlRestOperationDS, XmlRestOperationDS
public interface IRestOperationDS
This interface defines an operation of a rest service.
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
    getDocumentation()
    Returns the documentation of the operation.
    String
    getName()
    This method returns the name of the operation, may not be null.
    IRestRequestMessageDS
    getRequestMessage()
    This method returns the request message datasource representing the request, may not be null.
    IRestMessageDS
    getResponseMessage()
    This method returns the response message datasource representing the response, may not be null.

  • Field Details

    • CATEGORY

      static final Category CATEGORY

  • Method Details

    • getName

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

    • getDocumentation

      String getDocumentation()
      Returns the documentation of the operation.
      Returns:
      The documentation, may be null

    • getRequestMessage

      IRestRequestMessageDS getRequestMessage()
      This method returns the request message datasource representing the request, may not be null.
      Returns:
      The request message datasource.

    • getResponseMessage

      IRestMessageDS getResponseMessage()
      This method returns the response message datasource representing the response, may not be null.
      Returns:
      The response message datasource.