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

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

Constructors

VaultQueryCriteria

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

constructor(status: Vault.StateStatus)

constructor(status: Vault.StateStatus, contractStateTypes: Set<Class<out ContractState>>?)

constructor(status: Vault.StateStatus, contractStateTypes: Set<Class<out ContractState>>?, stateRefs: List<StateRef>?)

constructor(status: Vault.StateStatus, contractStateTypes: Set<Class<out ContractState>>?, stateRefs: List<StateRef>?, notary: List<AbstractParty>?)

constructor(status: Vault.StateStatus, contractStateTypes: Set<Class<out ContractState>>?, stateRefs: List<StateRef>?, notary: List<AbstractParty>?, softLockingCondition: QueryCriteria.SoftLockingCondition?)

Properties

constraints

open override val constraints: Set<Vault.ConstraintInfo>

constraintTypes

open override val constraintTypes: Set<Vault.ConstraintInfo.Type>

contractStateTypes

open override val contractStateTypes: Set<Class<out ContractState>>? = null

exactParticipants

open override val exactParticipants: List<AbstractParty>? = null

externalIds

open override val externalIds: List<UUID>

notary

val notary: List<AbstractParty>? = null

participants

open override val participants: List<AbstractParty>? = null

relevancyStatus

open override val relevancyStatus: Vault.RelevancyStatus

softLockingCondition

val softLockingCondition: QueryCriteria.SoftLockingCondition? = null

stateRefs

val stateRefs: List<StateRef>? = null

status

open override val status: Vault.StateStatus

timeCondition

val timeCondition: QueryCriteria.TimeCondition? = null

Functions

and

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

copy

fun copy(status: Vault.StateStatus = this.status, contractStateTypes: Set<Class<out ContractState>>? = this.contractStateTypes, stateRefs: List<StateRef>? = this.stateRefs, notary: List<AbstractParty>? = this.notary, softLockingCondition: QueryCriteria.SoftLockingCondition? = this.softLockingCondition, timeCondition: QueryCriteria.TimeCondition? = this.timeCondition): QueryCriteria.VaultQueryCriteria

This function copies this object.

fun copy(status: Vault.StateStatus = Vault.StateStatus.UNCONSUMED, contractStateTypes: Set<Class<out ContractState>>? = null, stateRefs: List<StateRef>? = null, notary: List<AbstractParty>? = null, softLockingCondition: QueryCriteria.SoftLockingCondition? = null, timeCondition: QueryCriteria.TimeCondition? = null, relevancyStatus: Vault.RelevancyStatus = Vault.RelevancyStatus.ALL, constraintTypes: Set<Vault.ConstraintInfo.Type> = emptySet(), constraints: Set<Vault.ConstraintInfo> = emptySet(), participants: List<AbstractParty>? = null): QueryCriteria.VaultQueryCriteria

This function creates a VaultQueryCriteria object with the given values. All other fields have the default values set.

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

visit

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

withConstraints

fun withConstraints(constraints: Set<Vault.ConstraintInfo>): QueryCriteria.VaultQueryCriteria

This function creates a new VaultQueryCriteria object with default values, and sets the value of constraints. Please use only one function in this group at a time to make sure they are not overwriting each other.

withConstraintTypes

fun withConstraintTypes(constraintTypes: Set<Vault.ConstraintInfo.Type>): QueryCriteria.VaultQueryCriteria

This function creates a new VaultQueryCriteria object with default values, and sets the value of constraintTypes. Please use only one function in this group at a time to make sure they are not overwriting each other.

withContractStateTypes

fun withContractStateTypes(contractStateTypes: Set<Class<out ContractState>>): QueryCriteria.VaultQueryCriteria

This function copies the existing VaultQueryCriteria object and sets the given value for contractStateTypes. You can use more than one of the functions in this group together. In case you are also using a function that creates a new VaultQueryCriteria object, make sure that you are calling that method first.

withExactParticipants

fun withExactParticipants(exactParticipants: List<AbstractParty>): QueryCriteria.VaultQueryCriteria

This function creates a new VaultQueryCriteria object with default values, and sets the value of exactParticipants. Please use only one function in this group at a time to make sure they are not overwriting each other.

withExternalIds

fun withExternalIds(externalIds: List<UUID>): QueryCriteria.VaultQueryCriteria

This function creates a new VaultQueryCriteria object with default values, and sets the value of externalIds. Please use only one function in this group at a time to make sure they are not overwriting each other.

withNotary

fun withNotary(notary: List<AbstractParty>): QueryCriteria.VaultQueryCriteria

This function copies the existing VaultQueryCriteria object and sets the given value for notary. You can use more than one of the functions in this group together. In case you are also using a function that creates a new VaultQueryCriteria object, make sure that you are calling that method first.

withParticipants

fun withParticipants(participants: List<AbstractParty>): QueryCriteria.VaultQueryCriteria

This function creates a new VaultQueryCriteria object with default values, and sets the value of participants. Please use only one function in this group at a time to make sure they are not overwriting each other.

withRelevancyStatus

fun withRelevancyStatus(relevancyStatus: Vault.RelevancyStatus): QueryCriteria.VaultQueryCriteria

This function creates a new VaultQueryCriteria object with default values, and sets the value of relevancyStatus. Please use only one function in this group at a time to make sure they are not overwriting each other.

withSoftLockingCondition

fun withSoftLockingCondition(softLockingCondition: QueryCriteria.SoftLockingCondition): QueryCriteria.VaultQueryCriteria

This function copies the existing VaultQueryCriteria object and sets the given value for softLockingCondition. You can use more than one of the functions in this group together. In case you are also using a function that creates a new VaultQueryCriteria object, make sure that you are calling that method first.

withStateRefs

fun withStateRefs(stateRefs: List<StateRef>): QueryCriteria.VaultQueryCriteria

This function copies the existing VaultQueryCriteria object and sets the given value for stateRefs. You can use more than one of the functions in this group together. In case you are also using a function that creates a new VaultQueryCriteria object, make sure that you are calling that method first.

withStatus

fun withStatus(status: Vault.StateStatus): QueryCriteria.VaultQueryCriteria

This function copies the existing VaultQueryCriteria object and sets the given value for status. You can use more than one of the functions in this group together. In case you are also using a function that creates a new VaultQueryCriteria object, make sure that you are calling that method first.

withTimeCondition

fun withTimeCondition(timeCondition: QueryCriteria.TimeCondition): QueryCriteria.VaultQueryCriteria

This function copies the existing VaultQueryCriteria object and sets the given value for timeCondition. You can use more than one of the functions in this group together. In case you are also using a function that creates a new VaultQueryCriteria object, make sure that you are calling that method first.