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: provides query by attributes defined in VaultSchema.VaultStates

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)

Properties

constraints

 val constraints: Set<ConstraintInfo>

constraintTypes

 val constraintTypes: Set<Type>

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

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

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 copies this object.

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

visit

 fun visit(parser: IQueryCriteriaParser): Collection<Predicate>

withConstraints

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.

fun withConstraints(constraints: Set<ConstraintInfo>): VaultQueryCriteria

withConstraintTypes

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.

fun withConstraintTypes(constraintTypes: Set<Type>): VaultQueryCriteria

withContractStateTypes

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.

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

withExactParticipants

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.

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

withExternalIds

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.

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

withNotary

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.

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

withParticipants

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.

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

withRelevancyStatus

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.

fun withRelevancyStatus(relevancyStatus: RelevancyStatus): VaultQueryCriteria

withSoftLockingCondition

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.

fun withSoftLockingCondition(softLockingCondition: SoftLockingCondition): VaultQueryCriteria

withStateRefs

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.

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

withStatus

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.

fun withStatus(status: StateStatus): VaultQueryCriteria

withTimeCondition

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.

fun withTimeCondition(timeCondition: TimeCondition): VaultQueryCriteria