FUNCTION <prefix>_API_<object type>_DISPLAY_CB.

Display function for the object being released

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

EXCEPTIONS:

NO_SUCCESS

Note:

This module must be identified as remote-enabled, as it is called with the Starting New Task command.

FUNCTION <prefix>_API_<object type>_CHANGE_CB.

Change function for the object being released

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

EXPORT

E_FLAG_MODIFIED TYPE BCA_REL_DTE_BOOLEAN

EXCEPTIONS:

NO_SUCCESS

FUNCTION <prefix>_API_<object type>_RELEASE_CB.

Function module for calling after the final, meaning the last release.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

I_FLG_INUPDATETASK TYPE BCA_REL_DTE_BOOLEAN DEFAULT CON_TRUE

EXCEPTIONS:

NO_SUCCESS

Note:

The callback module may not contain a COMMIT WORK or ROLLBACK WORK because the Framework for the Principle Control is the leading application at this point and issues a COMMIT WORK itself.

FUNCTION <prefix>_API_<object type>_REJECT_CB.

Function module for calling release function Reject

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

I_FLG_INUPDATETASK TYPE BCA_REL_DTE_BOOLEAN DEFAULT CON_TRUE

EXCEPTIONS:

NO_SUCCESS

Note:

The callback module may not contain a COMMIT WORK or ROLLBACK WORK because the Framework for the Principle Control is the leading application at this point and issues a COMMIT WORK itself.

FUNCTION <prefix>_API_<object type>_CHDOC_CB.

Display function for changes to data/change documents

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

I_CHANGED_AT TYPE BCA_REL_DTE_CHNGAT

EXCEPTIONS:

NO_SUCCESS

Note:

In addition to the object key (I_REL_OBJECT_KEY), for this call a time stamp (I_CHANGED_AT) is that specifies the time at which the Framework for the Principle of Dual Control was called the first time, so that all changes made since can be displayed.

FUNCTION <prefix>_API_<object type>_LOCK_CB.

Function module for setting or deleting SAP locks for this object.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

I_FLG_LOCKSET TYPE BCA_REL_DTE_BOOLEAN

EXCEPTIONS:

OBJECT_LOCKED

OBJECT_ERROR

Note:

Parameter I_FLG_LOCKSET specifies whether the lock is to be set ('X') or deleted (' ').

FUNCTION <prefix>_API_<object type>_GET_TXT_CB.

Function module for supplying the work item with a text from the application

This module is used for supplying the SAP Business Workflow with a text that is displayed as a work item text in the Business Workplace . The text is intended to provide exact details about which object and which application are involved. This can contain an external number, for example.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

EXPORT

E_STR_ITEMTXT TYPE BCA_STR_REL_ITEMTXT_DATA

Note:

In this module it is not permitted to access data that is possibly not written to the database until after the Framework for the Principle of Dual Control is called, as this would result in update terminations.

FUNCTION <prefix>_API_<object type>_RET_CB.

Function module for calling release function Return .An indication that the work item has been returned.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

I_FLG_INUPDATETASK TYPE BCA_REL_DTE_BOOLEAN DEFAULT CON_TRUE

EXCEPTIONS:

NO_SUCCESS

Note:

The callback module may not contain a COMMIT WORK or ROLLBACK WORK because the Framework for the Principle Control is the leading application at this point and issues the COMMIT WORK command itself.

FUNCTION <prefix>_API_<object type>_RETURN_CB.

Function module after release function Return is called.Processing of the returned work item.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

EXPORT

E_FLAG_MODIFIED TYPE BCA_REL_DTE_BOOLEAN

EXCEPTIONS:

NO_SUCCESS

Note:

For Release 4.6C and Release 6.20, this callback function module supports both parameter E_FLG_MODIFIED and parameter E_ORDERMODIFIED. From Release 6.40, only parameter E_FLG_MODIFIED is supported.

FUNCTION <prefix>_API_<object type>_BUTTON_CB.

Function module with which the application can suppress pushbuttons for individual functions of the Framework for the Principle of Dual Control in the Business Workplace .

Using this module you can modify the FUNCTIONFLAG indicator in the transferred table (C_TAH_RELFM) for individual callback function modules for the object just edited. If this indicator is set, the corresponding pushbutton appears on the interface, otherwise it is suppressed.

PARAMETER:

IMPORT

I_REL_OBJECT_KEY TYPE BCA_DTE_OBJECT_KEY

CHANGING

C_TAH_REL_FM TYPE BCA_TAH_REL_FM

FUNCTION <prefix>_API_<object type>_CHECK_CUST.

Function module for checking the settings in IMG activity Assign Release Object to Release Procedure after entry and before they are saved.

This function module is called when you enter a new release reason, when you change or delete an existing one, and also when you save. You have the option of making consistency checks and of integrating a dialog with any messages that occur, if applicable.

To do this, you transfer the following data on the interface of the callback function module:

Before saving: A table with the current Customizing settings for this release object

When inserting a new entry: A table with all the entries for this release object in the current version This can contain changes made within this LUW that have been classified as consistent. A table with the new entries is also transferred.

When changing an entry: A table with all the entries for this release object in the current version This can contain changes made within this LUW that have been classified as consistent. A table with changed entries is also transferred.

When you delete an entry, the table with the entries for changing is empty.

PARAMETER:

IMPORT

I_TAB_EXPR TYPE BCA_TAB_RELPROC_EXP

I_TAB_EXPR_NEW TYPE BCA_TAB_RELPROC_EXP

I_TAB_EXPR_CHG TYPE BCA_TAB_RELPROC_EXP

EXCEPTIONS:

INCONSISTENT

Note:

The callback module may not contain a COMMIT WORK or ROLLBACK WORK because the Framework for the Principle Control is the leading application at this point and issues the COMMIT WORK command itself.