Objects for Programming (Classes, Interfaces, Methods)

The following list provides an overview of the abstract classes, the interfaces, and the methods that are relevant for the programming of agents. For more information, see Programming Agents. For more information about the abstract classes, the interfaces, and the methods, see the system documentation for the classes, interfaces, and methods in the Class Builder (transaction code SE24).

Abstract class CL_OAF_AGENT

This class implements the following interface methods: The interface inherits the methods EXECUTE, SUPPRESS_INFO and FREE from the abstract class. You use the interface methods to adjust your requirements for the execution of agents and for the selection of change pointers by means of the Agent Framework.

Interface IF_OAF_AGENT
Method	Description
EXECUTE	Executes an agent. You have to redefine this abstract method.
SUPPRESS_INFO	Provides or suppresses additional information. You only have to program this concrete method if you do not want to use the existing program code.
FREE	For example, you use this to release resources. You only have to program this concrete method if you do not want to use the existing program code.

Interface IF_OAF_AGENT_CREATE

This interface describes the following method:

Method	Description
S_GET_AGENT	Provides instances for executing agents. You have to program this concrete method.

Interface IF_OAF_AGENT_LOG

You use this interface to include information in the application log. It describes the following methods:

Method	Description
ADD_EXCEPTION	Includes class-based exceptions in the application log.
ADD_MESSAGE	Includes messages in the application log.
GET_MESSAGE_CONTROL	Provides the value of the parameter that controls the inclusion of messages in the application log.

Interface IF_OAF_AGENT_CP

You use this interface to access the information on change pointers, export objects, and export object categories and to set the error status. It describes the following methods:

Method	Description
GET_ALL_CPS	Provides the change pointers.
GET_APPL_ID	Provides the application ID for one or more export objects.
GET_ALL_EXPOBJS	Provides the export objects.
GET_EXPOBJTYPE	Provides the export object categories for one or more export objects.
GET_IMAGES	Provides mappers to change pointers.
SET_ERROR_STATUS_FOR_CP	Sets the error status for change pointers.
SET_ERROR_STATUS_FOR_EXPOBJ	Sets the error status for export objects.