Vault.RelevancyStatus
Keywords: net.corda.core.node.services.Vault.RelevancyStatus class
Date: 2023-09-18

net.corda.core.node.services

## Enum Vault.RelevancyStatus

- Enclosing class:
    Vault<T extends ContractState>

      public static enum Vault.RelevancyStatus

  If the querying node is a participant in a state then it is classed as RELEVANT.

  If the querying node is not a participant in a state then it is classed as NOT_RELEVANT. These types of states can still be recorded in the vault if the transaction containing them was recorded with the StatesToRecord.ALL_VISIBLE flag. This will typically happen for things like reference data which can be referenced in transactions as a `class ReferencedStateAndRef` but cannot be modified by any party but the maintainer.

  If both RELEVANT and NOT_RELEVANT states are required to be returned from a query, then the ALL flag can be used.

  NOTE: Default behaviour is for ALL STATES to be returned as this is how Corda behaved before the introduction of this query criterion.

  See Also:
    StatesToRecord.ALL_VISIBLE, `class ReferencedStateAndRef`

- - ### Enum Constant Detail

    - #### RELEVANT

          public static net.corda.core.node.services.Vault.RelevancyStatus RELEVANT

    - #### NOT_RELEVANT

          public static net.corda.core.node.services.Vault.RelevancyStatus NOT_RELEVANT

    - #### ALL

          public static net.corda.core.node.services.Vault.RelevancyStatus ALL