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

VaultQueryCriteria

data class VaultQueryCriteria : CommonQueryCriteria

VaultQueryCriteria: provides query by attributes defined in VaultSchema.VaultStates

Constructors

<init>

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

VaultQueryCriteria: provides query by attributes defined in VaultSchema.VaultStates

Properties

constraintTypes

val constraintTypes: Set<Type>

constraints

val constraints: Set<ConstraintInfo>

contractStateTypes

val contractStateTypes: Set<Class<out ContractState>>?

exactParticipants

val exactParticipants: List<AbstractParty>?

externalIds

val externalIds: List<UUID>

notary

val notary: List<AbstractParty>?

participants

val participants: List<AbstractParty>?

relevancyStatus

val relevancyStatus: RelevancyStatus

softLockingCondition

val softLockingCondition: SoftLockingCondition?

stateRefs

val stateRefs: List<StateRef>?

status

val status: StateStatus

timeCondition

val timeCondition: TimeCondition?

Functions

copy

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

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

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

This function copies this object.

visit

fun visit(parser: IQueryCriteriaParser): Collection<<ERROR CLASS>>

withConstraintTypes

fun withConstraintTypes(constraintTypes: Set<Type>): 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.

withConstraints

fun withConstraints(constraints: Set<ConstraintInfo>): 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.

withContractStateTypes

fun withContractStateTypes(contractStateTypes: Set<Class<out ContractState>>): 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>): 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>): 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>): 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>): 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: RelevancyStatus): 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: SoftLockingCondition): 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>): 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: StateStatus): 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: TimeCondition): 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.