Available Parameters
The following parameters can be used:
- On get/set hooks always have one output parameter and zero or more input parameters. The output parameter is the attribute implementations being get/set. The input parameters are the used attributes as specified for the attribute implementations being get/set.
- Before get/set hooks have one output parameter io.cancel, and zero or more input parameters for the used attributes.
- After get/set hooks only have input parameters, being the used attributes.
- Conversion get/set hooks have one input parameter and one output parameter. For a conversion get hook, the input parameter is the value from the attribute implementation, and the output parameter is the value for the corresponding attribute. For a conversion set hook, the input parameter is the value for the attribute, and the output parameter is the value for the corresponding attribute implementation.
The attribute implementation names are used in the parameter names.
The parameters are named as follows:
| Hook | Available Parameters | Variable Names |
|---|---|---|
| before/on/after get/set | Input parameters for used attributes | If the attribute implementation names of the used attributes are orderNumber and businessPartner: i.orderNumber, i.businessPartner |
| before get/set | Input/output parameter for cancel | io.cancel |
| on get/set | Output parameter for attribute being get/set | If the name of the attribute implementation being retrieved/set is orderQuantity: o.orderQuantity |
| after get/set | Input parameter for attribute being get/set | If the name of the attribute implementation being retrieved/set is orderQuantity: i.orderQuantity |
| default value | Input/output parameter for attribute implementation, and input parameters for used attributes (if any) | if the name of the attribute implementation is orderType: io.orderType, if the attribute implementation names of the used attributes are orderNumber and businessPartner: i.orderNumber, i.businessPartner |
| conversion get | Input parameter for attribute implementation; output parameter for corresponding attribute | if the name of the attribute implementation is orderType: i.orderType, o.orderType |
| conversion set | Input parameter for attribute; output parameter for corresponding attribute implementation | if the name of the attribute implementation is orderType: i.orderType, o.orderType |
| filter | Output parameter for filter | o.hookFilter |
The data type of the parameters is the same as the data type of the attribute implementations involved.
In case attribute grouping is used, the attribute implementation names by default contain the path, using underscores. For example, if the following structure exists:
Component ‘Order’ -> group ‘Customer’ -> group ‘Address’ -> attribute ‘city’
then the attribute implementation name will be:
‘Customer_Address_city’