Package com.aquima.interactions.communication.ds

Interface IRestServiceDS

All Superinterfaces:
IReportingDS
All Known Implementing Classes:
ReportingRestServiceDS, XmlRestServiceDS, XmlRestServiceDS
public interface IRestServiceDS extends IReportingDS
This interface defines a rest service.
Since:
9.0
Author:
Arjan Pragt

  • Method Summary

    Modifier and Type
    Method
    Description
    RestServiceDirection
    getDirection()
    This method returns the direction of the rest service, may not be null.
    String
    getLocation()
    This method returns the location of the service, may be null.
    String
    getName()
    This method returns the name of the service, may not be null.
    String
    getSchemaSet()
    This method returns the name of the corresponding schemaset, may not be null in case of schema set service, must be null in case of domain schemas.
    void
    iterateOperations(IRestOperationVisitor visitor)
    This method iterates about the operations.
    boolean
    useDomainSchemas()
    Returns an indicator whether to use domain schemas instead of schemaset.

    Methods inherited from interface com.aquima.interactions.foundation.report.IReportingDS

    addMessage

  • Method Details

    • getName

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

    • getLocation

      String getLocation()
      This method returns the location of the service, may be null.
      Returns:
      The url of the service.

    • useDomainSchemas

      boolean useDomainSchemas()
      Returns an indicator whether to use domain schemas instead of schemaset.
      Returns:
      domain schema indicator.

    • getSchemaSet

      String getSchemaSet()
      This method returns the name of the corresponding schemaset, may not be null in case of schema set service, must be null in case of domain schemas.
      Returns:
      The name of the schemaSet.

    • iterateOperations

      void iterateOperations(IRestOperationVisitor visitor)
      This method iterates about the operations.
      Parameters:
      visitor - The visitor accepting the operations.

    • getDirection

      RestServiceDirection getDirection()
      This method returns the direction of the rest service, may not be null.
      Returns:
      Whether the service consumes, serves or both.