Interface APIResponse.Links

  • All Known Implementing Classes:
    APIResponseDTO.LinksDTO
    Enclosing interface:
    APIResponse<T>

    public static interface APIResponse.Links
    Interface representing optional paging information for remote service requests supporting pagination


    Please note that, as the remote service declares all of the properties to be optional, most of the methods are marked as Nullable. Methods returning collection-based values however will return an empty collection in case no corresponding data was received.

    • Method Detail

      • getFirst

        @Nullable
        Integer getFirst()
        Get the number of the first available page. Resolves to the value of the {links.first} JSON property.
        Returns:
        The number of the first available page
      • getLast

        @Nullable
        Integer getLast()
        Get the number of the last available page. Resolves to the value of the {links.last} JSON property.
        Returns:
        The number of the last available page
      • getNext

        @Nullable
        Integer getNext()
        Get the number of the next page (if available). Resolves to the value of the {links.next} JSON property.
        Returns:
        The number of the next page
      • getPrevious

        @Nullable
        Integer getPrevious()
        Get the number of the previous page (if available). Resolves to the value of the { links.previous} JSON property.
        Returns:
        The number of the previous page