Class ScimListPage

java.lang.Object
com.revetsec.scim.ScimListPage

@Immutable @CheckReturnValue public final class ScimListPage extends Object
Application-authored page framing for one approved query; storage and count accuracy are app-owned. INDEX pages require a nonnegative accurate totalResults and a consistent result window. CURSOR pages declare more results exactly when a nextCursor is present; the first page has no previousCursor. A short page alone does not prove exhaustion. For either method, a zero count requires accurate totalResults, empty resources and no traversal cursors or more-results flag. Construction checks framing and resource-type identity, not the truth of storage metadata or cursor authenticity. The originating provider checks private query/resource associations before rendering the page.
Since:
1.0.0
  • Method Details

    • getQuery

      Returns the originating approved query whose bounds and projection frame this page.
      Returns:
      the original query
      Since:
      1.0.0
    • getResources

      Returns the immutable application-supplied resource snapshot in represented page order. Every resource uses the query's exact resource-type registration and the list is no larger than the query's effective count.
      Returns:
      the resources
      Since:
      1.0.0
    • getTotalResults

      Returns the application's declared accurate nonnegative matching-resource total, when present. It is required for INDEX and every count-only page; ordinary CURSOR pages may omit it.
      Returns:
      the declared total, or empty when omitted
      Since:
      1.0.0
    • getNextCursor

      Returns the application's next-page token, present exactly when more results are declared. The token's authenticity, context and validity remain application responsibilities.
      Returns:
      the next cursor, or empty when no next page is declared
      Since:
      1.0.0
    • getPreviousCursor

      Returns the application's previous-page token, when available. The first cursor page, INDEX pages and count-only pages cannot have a previous token.
      Returns:
      the previous cursor, or empty when unavailable
      Since:
      1.0.0
    • isMoreResultsAvailable

      Reports the application's more-results declaration, true exactly when nextCursor is present. A short page does not itself imply false; INDEX and count-only pages require false.
      Returns:
      whether a next cursor page is declared
      Since:
      1.0.0
    • withQuery

      Starts page framing for an approved query with empty resources, absent total/cursors and moreResultsAvailable false. Supply the metadata required by the query's framing before build.
      Parameters:
      query - the originating approved query
      Returns:
      builder
      Since:
      1.0.0
    • toString

      Returns a redacted diagnostic.
      Overrides:
      toString in class Object
      Returns:
      description
      Since:
      1.0.0