Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

Excerpt
hiddentrue

model-field hook - defines new hook in existing model.

...

This module is used for defining new hook in existing model. Please see also articles describing defining model using XML and model hooks.

Module's schema is defined in model.xsd.

...

name

type

required

description

plugin

string

yes

Name of the plugin where the model belongs.

model

string

yes

Name of the model where the hook will be added.

node value

string

yes

Definition of the hook. Please see an article describing defining model hook using XML.

Example

Please find below an example of plugin defining one hook module. Lines 8-10 contains contain a module which defines new on-save hook in model sampleModel which belongs to the plugin otherPlugin.

Code Block
themeEclipse
languagexml
themeEclipse
linenumberstrue
<?xml version="1.0" encoding="UTF-8"?>
<plugin plugin="samplePlugin" version="1.0.0" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schema.qcadoo.org/plugin" 
    xmlns:model="http://schema.qcadoo.org/modules/model" 
    xsi:schemaLocation="http://schema.qcadoo.org/plugin http://schema.qcadoo.org/plugin.xsd http://schema.qcadoo.org/modules/model http://schema.qcadoo.org/modules/model.xsd">

    <model:model-hook plugin="otherPlugin" model="sampleModel">
        <onSave<model:onSave class="com.qcadoo.samplePlugin.SampleHookService" method="callMeOnSave" />
    </model:model-field>

</plugin>