corda / net.corda.core.node.services / Vault / Page

Page

data class Page<out T : ContractState>

Returned in queries VaultService.queryBy and VaultService.trackBy. A Page contains:

  1. a List of actual StateAndRef requested by the specified QueryCriteria to a maximum of MAX_PAGE_SIZE.
  2. a List of associated Vault.StateMetadata, one per StateAndRef result.
  3. a total number of states that met the given QueryCriteria if a PageSpecification was provided, otherwise it defaults to -1.
  4. Status types used in this query: StateStatus.UNCONSUMED, StateStatus.CONSUMED, StateStatus.ALL.
  5. Other results as a List of any type (eg. aggregate function results with/without group by).

Note: currently otherResults are used only for Aggregate Functions (in which case, the states and statesMetadata results will be empty).

Constructors

<init>

Returned in queries VaultService.queryBy and VaultService.trackBy. A Page contains:

Page(states: List<StateAndRef<T>>, statesMetadata: List<StateMetadata>, totalStatesAvailable: Long, stateTypes: StateStatus, otherResults: List<Any>)

Properties

otherResults

val otherResults: List<Any>

states

val states: List<StateAndRef<T>>

statesMetadata

val statesMetadata: List<StateMetadata>

stateTypes

val stateTypes: StateStatus

totalStatesAvailable

val totalStatesAvailable: Long