# FilterCorrelatorType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Supertype: AbstractCorrelatorType
A correlator that uses a specified filter to find shadow owner.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
order | property int | [0,1] | Order in which this correlator is to be evaluated.
authority | property CorrelatorAuthorityLevelType | [0,1] | TODO
using | property string | [0,1] | Reference to the correlator to be used at this place.
extending | property string | [0,1] | Reference to an upstream definition of correlator.
name | property string | [0,1] | Name of the correlator.
displayName | property string | [0,1] |
description | property string | [0,1] |
documentation | property string | [0,1] |
definitions | container CorrelatorDefinitionsType | [0,1] | TODO
ownerFilter | property ConditionalSearchFilterType | [0,-1] | The filter that should return a list of candidate focus entries that may be owners of a particular shadow.
confirmation | property ExpressionType | [0,1] | Confirmation expression.
useConfirmationForSingleCandidate | property boolean | [0,1] | Should be the confirmation expression used also when there is only a single candidate found by the filter? (The default is true.
selection | property ExpressionType | [0,1] | Selection expression.

- ### Items

  - #### order

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Order in which this correlator is to be evaluated. (Related to other correlators.) Smaller numbers go first. Entries with no order go last.

  - #### authority

    Flags: RAM,runtime,AVals:3

    Multiplicity: [0,1]

    TODO

  - #### using

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Reference to the correlator to be used at this place. TODO refine this specification TODO implement

  - #### extending

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Reference to an upstream definition of correlator. It is used as a template for this correlator. TODO refine this specification TODO implement

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Name of the correlator. Should be unique in the given context (object type definition, resource, or system-wide).

  - #### displayName

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

  - #### definitions

    Flags: RAM,runtime

    Multiplicity: [0,1]

    TODO

  - #### ownerFilter

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    The filter that should return a list of candidate focus entries that may be owners of a particular shadow.

    The filter in this case is conditional, i.e. there can be specified an expression that denotes a necessary condition for the filter to be applied.

    Beware that the list of filters is unordered, so individual filters can be executed in arbitrary order. If you want to prescribe specific order, please use multiple filter correlators.

  - #### confirmation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Confirmation expression. The arguments are an account and a candidate owner (user). The confirmation expressions should return true if the user should be owner of the account. It should return false if the user cannot be owner of the account. The evaluation of the confirmation expression may be relatively inefficient, as it will only be run for candidate entries returned by correlation expression. TODO review this The expression variables should be set as follows: $user - the candidate user object (one of the results of correlation expression) $account - the changed account object

  - #### useConfirmationForSingleCandidate

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Should be the confirmation expression used also when there is only a single candidate found by the filter? (The default is true. This is consistent with midPoint 4.3+ behavior. Before midPoint 4.3, the default was false.)

  - #### selection

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Selection expression. Obtains a collection of all found candidate objects, and returns the one(s) that should be selected. NOT IMPLEMENTED YET.