Package com.sap.caf.eu.gp.co.api

Guided Procedures Callable Object API Introduction The API allows implementation of GP Callable Objects.

See:
Description

Interface Summary

IGPBackgroundCallableObject	A callable object is the smallest executable unit within the Guided Procedures model framework.
IGPCallableObject	The callable object stores infromation about the implementation of a step inside a Guided Procedure.
IGPConfigAttributeInfo	Describes the definition of a configuration attribute.
IGPConfigAttributeValue	Describes an option value for configuration attribute.
IGPCOResultStateInfo	Describes a result state definition of the callable object.
IGPExceptionInfo	Describes a process exception definition.
IGPExecutionContext	The excecution context is passed to all technical implementations of callable objects and provides accessor methods to the publicly released objects of the execution context(input and output paramters, configuration parameters).
IGPMutableOperationResponse
IGPPhysicalCallableObject	The physical callable object stores technical information about the object that should be invoked during action execution.
IGPResourceAccessor	Provides an abstract interface for a resource accessor to allow implementations to return texts in a way that does not necessarily rely on the standard resource accessor implementation (e.g. in web dynpro components).
IGPTechnicalDescription	Returns meta information about technical callable object implementation.
IGPVisibleCOContainerContext	This interface is used for getting specific properties runtime for the visible part of the callable object.

Class Summary

GPCallableObjectFactory
GPStandardResourceAccessor	Basic resource accessor imlementation to be used with background callable objects.
GPWebDynproResourceAccessor

Package com.sap.caf.eu.gp.co.api Description

Guided Procedures Callable Object API

Introduction

The API allows implementation of GP Callable Objects. A callable object implementation consists of design time and runtime part. There are two methods in the callable object interface (Java or WebDynpro) corresponding to these two phases.

• The method getTechnicalDescription() is called by the Guided Procedures design time. The callable object implementation should return an instance of ITechnicalDescription, which provides the following meta data: name and description; input and output parameters additional configuration parameters, callable object result states and process exceptions.
• The method execute(IExecutionContext context) is called by the Guided Procedures runtime. The runtime and passes an instance of IExecutionContext. The callable object uses the execution context for retrieving the input and configuration parameters, setting output parameters and result states or process exceptions.

Design Time

Create technical description.

The technical description is created through the TechnicalDescriptionFactory.newTechnicalDescription() method. It requires resource accessor and original locale, as well as resource keys for the localizable name and description of the callable object.

Define input and output structures

The technical description provides the root structures for the input and output parameters. Use the methods IStructureInfo getInputStructureInfo and IStructureInfo getOutputStructureInfo() to obtain these structures and create input and output parameter definitions. The callable object can specify if additional input or output parameters are allowed to be added through the Guided Procedures design time. The methods setAdditionalInputParamAllowed(boolean isAllowed) and setAdditionalOutputParamAllowed(boolean isAllowed) are used to specify this. The default is that no additional input or output parameters are allowed.

Define configuration parameters.

The configuration parameters are added through the addConfigurationAttribute method. The method returns and instance of IConfigAttributeInfo, which can be used to specify localizable name and description, default value or enumeration of values (by default the resource keys for the name and the description are equal to the technical name of the configuration attribute).

Define process exceptions

Process exceptions can be added through the IExceptionInfo addProcessException method. The instance of IExceptionInfo is to assign localizable name and description to the process exception (by default the resource keys for the name and the description are equal to the technical name of the process exception).

Define callable objects result states.

Result states are added through the IResultStateInfo addResultState method. The instance of the IResultStateInfo can be used to specify resource keys for the name and the description of the result state (by default the keys are equal to the technical name of the result state). A callable object should define at least one result state.

Runtime

Get input and specify output parameters

During callable object execution the input parameters are retrieved through the execution context. The method IStructure getInputStructure() is used to get the root structure of the input context and parameters values accordingly. The method IStructureInfo getInputStructureInfo() can be used to obtain the input parameters definition. It is used if additional input parameters are allowed to be added in Guided Procedures design time. The method IStructure getOutputStructure() is used to retrieve the root structure for the output parameters. The instance of IStructure is used to set attribute values and add additional structures. The output structure info can be used to obtain the parameter definition and check if additional output parameters are added through the Guided Procedures design time.

Get configuration attribute values

The method String getConfigParameterValue(String name) is used to retrieve the configuration attribute value. The attribute value is converted to string.

Set result state(s) or process exception. Complete callable object execution

A callable object execution ends with specifying at least one result state or specifying a process exception. The result states are specified through the methods setResultState(String resultStateName) and addResultState(String resultStateName). The callable object implementation should call the method processingComplete() to to specify that the execution is complete.