# HookType (Complex Type)

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

TODO

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property string | [0,1] | Free-form hook name.
description | property string | [0,1] |
documentation | property string | [0,1] | Technical documentation for a particular object or construct.
enabled | property boolean | [0,1] |
state | property ModelStateType | [0,1] |
focusType | property QName | [0,1] |
ref | property anyURI | [0,1] | URL of hook handler.
script | property ScriptExpressionEvaluatorType | [0,1] | Script that will be executed instead of hook handler.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Free-form hook name. Used for diagnostic purposed (e.g. in log files)

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Technical documentation for a particular object or construct.

    The purpose of this element is to document system configuration and behavior. The documentation will not be presented to end users. In fact, it will probably not be presented at all in midPoint user interface. This documentation element is supposed to be a part of the technical documentation of midPoint deployment. The tools than generate deployment configuration will look for these elements and combine them to compiled documentation document.

    AsciiDoc formatting is assumed for this element. Any leading or trailing whitespace is skipped. Indentation equivalent to he indentation of the first non-blank line of text is also skipped.

  - #### enabled

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

  - #### state

    Flags: RAM,runtime,AVals:6

    Multiplicity: [0,1]

    Display order:

  - #### focusType

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

  - #### ref

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    URL of hook handler. Exactly one of "ref" or "script" has to be specified.

  - #### script

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Script that will be executed instead of hook handler. Exactly one of "ref" or "script" has to be specified.