Interface RESTRequest

All Superinterfaces:
DataRetrievalRequest
All Known Implementing Classes:
RESTRequestImpl
public interface RESTRequest extends DataRetrievalRequest
Represents a request to a particular endpoint of a REST API.

  • Method Summary

    Modifier and Type
    Method
    Description
    default ExpectedVariables
    getExpectedVariables()
    Returns the query variables for which this data retrieval request aims to fetch data (if any), where some of these variables may be 'certain variables' whereas others are 'possible variables'.
    URI
    getURI()
    Returns the URI to be requested.

    Methods inherited from interface se.liu.ida.hefquin.federation.access.DataRetrievalRequest

    toString

  • Method Details

    • getURI

      URI getURI()
      Returns the URI to be requested.

    • getExpectedVariables

      default ExpectedVariables getExpectedVariables()
      Description copied from interface: DataRetrievalRequest
      Returns the query variables for which this data retrieval request aims to fetch data (if any), where some of these variables may be 'certain variables' whereas others are 'possible variables'. For the distinction between these two types of variables, refer to ExpectedVariables.getCertainVariables() and to
      invalid @link 
      {@link ExpectedVariables#getPossibleVariables())
      }. For instance, if this request is about fetching triples that match a given triple pattern, then the variables of that triple pattern would be returned here as certain variables. Note that the method may also return null (which would be the case for types of data retrieval requests for which this method is not applicable in any reasonable way).
      Specified by:
      getExpectedVariables in interface DataRetrievalRequest