docs/net.corda.core.node.services.vault/QueryCriteria

QueryCriteria

sealed class QueryCriteria : GenericQueryCriteria<QueryCriteria, IQueryCriteriaParser> , GenericQueryCriteria.ChainableQueryCriteria<QueryCriteria, IQueryCriteriaParser>

Indexing assumptions: QueryCriteria assumes underlying schema tables are correctly indexed for performance.

Inheritors

CommonQueryCriteria

AndComposition

OrComposition

Types

AndComposition

class AndComposition(val a: QueryCriteria, val b: QueryCriteria) : QueryCriteria, GenericQueryCriteria.ChainableQueryCriteria.AndVisitor<QueryCriteria, IQueryCriteriaParser, Sort>

CommonQueryCriteria

abstract class CommonQueryCriteria : QueryCriteria

FungibleAssetQueryCriteria

data class FungibleAssetQueryCriteria(val participants: List<AbstractParty>? = null, val owner: List<AbstractParty>? = null, val quantity: ColumnPredicate<Long>? = null, val issuer: List<AbstractParty>? = null, val issuerRef: List<OpaqueBytes>? = null, val status: Vault.StateStatus = Vault.StateStatus.UNCONSUMED, val contractStateTypes: Set<Class<out ContractState>>? = null, val relevancyStatus: Vault.RelevancyStatus, val exactParticipants: List<AbstractParty>? = null) : QueryCriteria.CommonQueryCriteria

FungibleStateQueryCriteria: provides query by attributes defined in VaultSchema.VaultFungibleStates

FungibleStateQueryCriteria

data class FungibleStateQueryCriteria(val participants: List<AbstractParty>? = null, val quantity: ColumnPredicate<Long>? = null, val status: Vault.StateStatus = Vault.StateStatus.UNCONSUMED, val contractStateTypes: Set<Class<out ContractState>>? = null, val relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.ALL) : QueryCriteria.CommonQueryCriteria

FungibleStateQueryCriteria: provides query by attributes defined in VaultSchema.VaultFungibleStates

LinearStateQueryCriteria

data class LinearStateQueryCriteria(val participants: List<AbstractParty>? = null, val uuid: List<UUID>? = null, val externalId: List<String>? = null, val status: Vault.StateStatus = Vault.StateStatus.UNCONSUMED, val contractStateTypes: Set<Class<out ContractState>>? = null, val relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.ALL, val exactParticipants: List<AbstractParty>?) : QueryCriteria.CommonQueryCriteria

LinearStateQueryCriteria: provides query by attributes defined in VaultSchema.VaultLinearState

OrComposition

class OrComposition(val a: QueryCriteria, val b: QueryCriteria) : QueryCriteria, GenericQueryCriteria.ChainableQueryCriteria.OrVisitor<QueryCriteria, IQueryCriteriaParser, Sort>

SoftLockingCondition

data class SoftLockingCondition(val type: QueryCriteria.SoftLockingType, val lockIds: List<UUID> = emptyList())

Select states based on their locks.

SoftLockingType

enum SoftLockingType : Enum<QueryCriteria.SoftLockingType>

TimeCondition

data class TimeCondition(val type: QueryCriteria.TimeInstantType, val predicate: ColumnPredicate<Instant>)

TimeInstantType

enum TimeInstantType : Enum<QueryCriteria.TimeInstantType>

VaultCustomQueryCriteria

data class VaultCustomQueryCriteria<L : StatePersistable>(val expression: CriteriaExpression<L, Boolean>, val status: Vault.StateStatus = Vault.StateStatus.UNCONSUMED, val contractStateTypes: Set<Class<out ContractState>>? = null, val relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.ALL) : QueryCriteria.CommonQueryCriteria

VaultCustomQueryCriteria: provides query by custom attributes defined in a contracts QueryableState implementation. (see Persistence documentation for more information)

VaultQueryCriteria

data class VaultQueryCriteria(val status: Vault.StateStatus = Vault.StateStatus.UNCONSUMED, val contractStateTypes: Set<Class<out ContractState>>? = null, val stateRefs: List<StateRef>? = null, val notary: List<AbstractParty>? = null, val softLockingCondition: QueryCriteria.SoftLockingCondition? = null, val timeCondition: QueryCriteria.TimeCondition? = null, val relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.ALL, val constraintTypes: Set<Vault.ConstraintInfo.Type> = emptySet(), val constraints: Set<Vault.ConstraintInfo> = emptySet(), val participants: List<AbstractParty>? = null, val externalIds: List<UUID> = emptyList(), val exactParticipants: List<AbstractParty>? = null) : QueryCriteria.CommonQueryCriteria

VaultQueryCriteria: provides query by attributes defined in VaultSchema.VaultStates

Functions

and

open infix override fun and(criteria: QueryCriteria): QueryCriteria

open infix override fun or(criteria: QueryCriteria): QueryCriteria

visit

abstract fun visit(parser: IQueryCriteriaParser): Collection<<Error class: unknown class>>