Package com.xebialabs.deployit.plugin.api.udm

# Annotation Interface CandidateValuesFilter

@Documented @Retention(RUNTIME) @Target(METHOD) @Inherited public @interface CandidateValuesFilter
A CandidateValuesFilter can augment the `SearchParameters` for a ConfigurationItem search.

A @CandidateValuesFilter method should adhere to the following rules:

- The method should be static
- The method should take 2 parameters:
  1. The `ConfigurationItem` that is the context
  2. The `PropertyDescriptor` that the filter should be based on.
- The method should return a new `SearchParameters`

- ## Required Element Summary

  Required Elements
  Modifier and Type
  Required Element
  Description
  `String`
  `name`

- ## Element Details

  - ### name

    String name
    Returns:
      The name of the filter