Package net.corda.v5.ledger.utxo.query
Interface VaultNamedParameterizedQuery
-
- All Implemented Interfaces:
-
net.corda.v5.application.persistence.PagedQuery
,net.corda.v5.application.persistence.ParameterizedQuery
public interface VaultNamedParameterizedQuery<R> implements ParameterizedQuery<R>
Representation of a vault named query.
Ensure that R matches the type returned from the VaultNamedQueryTransformer and/or VaultNamedQueryCollector (both optional) for the vault named query that this query object executes.
If no VaultNamedQueryTransformer or VaultNamedQueryCollector is applied to the vault named query, the ResultSet from executing this query will contain StateAndRefs.
-
-
Method Summary
Modifier and Type Method Description abstract VaultNamedParameterizedQuery<R>
setLimit(int limit)
abstract VaultNamedParameterizedQuery<R>
setOffset(int offset)
abstract VaultNamedParameterizedQuery<R>
setParameter(@NotNull() String name, @NotNull() Object value)
abstract VaultNamedParameterizedQuery<R>
setParameters(@NotNull() Map<String, Object> parameters)
abstract VaultNamedParameterizedQuery<R>
setCreatedTimestampLimit(@NotNull() Instant timestampLimit)
Sets the timestamp limit for the query. abstract PagedQuery.ResultSet<R>
execute()
Executes the VaultNamedParameterizedQuery and creates a PagedQuery.ResultSet containing the results of the query. -
-
Method Detail
-
setLimit
@NotNull() abstract VaultNamedParameterizedQuery<R> setLimit(int limit)
-
setOffset
@NotNull() abstract VaultNamedParameterizedQuery<R> setOffset(int offset)
-
setParameter
@NotNull() abstract VaultNamedParameterizedQuery<R> setParameter(@NotNull() String name, @NotNull() Object value)
-
setParameters
@NotNull() abstract VaultNamedParameterizedQuery<R> setParameters(@NotNull() Map<String, Object> parameters)
-
setCreatedTimestampLimit
@NotNull() abstract VaultNamedParameterizedQuery<R> setCreatedTimestampLimit(@NotNull() Instant timestampLimit)
Sets the timestamp limit for the query. This will influence which results are returned.
- Parameters:
timestampLimit
- The timestamp limit the query should enforce.
-
execute
@Suspendable()@NotNull() abstract PagedQuery.ResultSet<R> execute()
Executes the VaultNamedParameterizedQuery and creates a PagedQuery.ResultSet containing the results of the query.
The results of the query depends on the executed named query and the VaultNamedQueryTransformer and/or VaultNamedQueryCollector (both optional) applied to it.
If no VaultNamedQueryTransformer or VaultNamedQueryCollector is applied to the vault named query, the ResultSet will contain StateAndRefs.
-
-
-
-