Check Function Module 

Use

If the check function module terminates with an exception, the receiver function module is not called and the linkage between the event and the receiver therefore not established.

Using a check function module gives the event receiver the opportunity to decide whether the receiver should actually be called for general or non-specific events before the call actually takes place.

The event Notification created should only actually lead to the receiver being called, if the notification is a service notification.

A check function module exception has no effect on the event creator.

The container passed in the interface of the function module is read with macro instructions provided. If object references were passed in the container, they must first be converted into runtime handles.

For further information and a full list of all macro instructions, refer to:

Integration

The check function module must be provided by the potential event receiver, if applicable.

The check function module has the same interface as the receiver function module. This allows the contents of the event container to be checked.

Features

The interface of the check function module is described with the following parameters:

Import parameters

OBJTYPE

SWETYPECOU-OBJTYPE

Type of triggering object

OBJKEY

SWEINSTCOU-OBJKEY

Concatenated, object type-specific key of the triggering object

The reference to the triggering object is created internally from this information and written to the event container under the element ID _Evt_Object .

EVENT

SWEINSTCOU-EVENT

ID of event

The event must be defined for the triggering object type.

RECTYPE

SWETYPECOU-RECTYPE

Receiver type.

Table parameters

EVENT_CONTAINER

SWCONT

Persistent event container of the event.

Exception

If the check function module terminates without an exception, the receiver function module is called by the event manager.

If the check function module terminates with any exception, the receiver function module is not called. Exceptions are not treated in different ways.

There is a template function module for check function modules ( SWE_CD_TEMPLATE_CHECK_FB ) in the function group SWE_TEMPLATE .