Interface DataRetrievalResponse<T>

All Known Subinterfaces:
CardinalityResponse, JSONResponse, RecordsResponse, SolMapsResponse, StringResponse, TPFResponse, TriplesResponse
All Known Implementing Classes:
CachedCardinalityResponseImpl, CardinalityResponseImpl, CardinalityResponseImplWithoutCardinality, DataRetrievalResponseBase, JSONResponseImpl, RecordsResponseImpl, SolMapsResponseImpl, StringResponseImpl, TPFResponseImpl, TriplesResponseImpl
public interface DataRetrievalResponse<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    default String
    getErrorDescription()
    Returns a short description of the error if available, or empty otherwise.
    default Integer
    getErrorStatusCode()
    Returns the HTTP status code if the response resulted in an error, or empty otherwise.
    FederationMember
    getFederationMember()
    Returns the federation member where this response comes from.
    DataRetrievalRequest
    getRequest()
    Returns the request that has been issued to obtain this response.
    default Duration
    getRequestDuration()
    Returns the total duration between request start and request end.
    Date
    getRequestStartTime()
    Returns the time at which the corresponding data retrieval request (see getRequest()) was started.
    T
    getResponseData()
    Returns the data retrieved in response to the corresponding request, or throws UnsupportedOperationDueToRetrievalError if an error occurred during data retrieval.
    Date
    getRetrievalEndTime()
    Returns the time at which the retrieval of this response was completed.
    default boolean
    isError()
    Indicates whether an error occurred during data retrieval.

  • Method Details

    • getFederationMember

      FederationMember getFederationMember()
      Returns the federation member where this response comes from.

    • getRequest

      DataRetrievalRequest getRequest()
      Returns the request that has been issued to obtain this response.

    • getRequestStartTime

      Date getRequestStartTime()
      Returns the time at which the corresponding data retrieval request (see getRequest()) was started.

    • getRetrievalEndTime

      Date getRetrievalEndTime()
      Returns the time at which the retrieval of this response was completed.

    • getRequestDuration

      default Duration getRequestDuration()
      Returns the total duration between request start and request end.

    • isError

      default boolean isError()
      Indicates whether an error occurred during data retrieval.

    • getResponseData

      T getResponseData() throws UnsupportedOperationDueToRetrievalError
      Returns the data retrieved in response to the corresponding request, or throws UnsupportedOperationDueToRetrievalError if an error occurred during data retrieval.
      Throws:
      UnsupportedOperationDueToRetrievalError

    • getErrorStatusCode

      default Integer getErrorStatusCode()
      Returns the HTTP status code if the response resulted in an error, or empty otherwise.

    • getErrorDescription

      default String getErrorDescription()
      Returns a short description of the error if available, or empty otherwise.