com.sap.aii.mappingtool.tf7.rt

Interface GlobalContainer

public interface GlobalContainer

An instance of this class enables you to cache the values that you want to read again when you next call any user-defined function in the same message mapping. A message mapping has exactly one global container during the execution.

Furthermore, in the same as for Container , you can also access the fields of the message header by using the GlobalContainer object.

Note that the sequence in which user-defined functions are called is predefined. It depends on the position of the target fields that the function was assigned to. Imagine a target structure in the mapping editor in which all the structure nodes have been expanded. The fields are processed from top to bottom, starting at the root node.

To get a global container object, call the method Container.getGlobalContainer().

See Also:

Container

Method Summary

void	copyInputAttachments()
InputAttachments	getInputAttachments()
InputHeader	getInputHeader() Returns the access to the message header input parameters.
InputParameters	getInputParameters() Returns the access to the import parameters which have been defined in the signature tab of the message mapping editor.
OutputAttachments	getOutputAttachments()
OutputHeader	getOutputHeader() Returns the access to the message header output parameters.
OutputParameters	getOutputParameters() Returns the access to the export parameters which have been defined in the signature tab of the message mapping editor.
Object	getParameter(String name) Returns the object that was saved under the given name in the global container by using the setParameter method.
Map	getParameters() Deprecated. use getInputParameters() instead
AbstractTrace	getTrace() Returns the mapping trace object.
void	setParameter(String name, Object value) Saves a given object under the given name in a global container, which can be accessed by all user-defined functions of a message mapping.

Method Detail

setParameter

void setParameter(String name,
                  Object value)

Saves a given object under the given name in a global container, which can be accessed by all user-defined functions of a message mapping.

Parameters:

name - parameter name

value - parameter value

getParameter

Object getParameter(String name)

Returns the object that was saved under the given name in the global container by using the setParameter method. If no such parameter exists, null is returned.

Parameters:

name - parameter name

Returns:

parameter value or null if the parameter does not exist.

getInputHeader

InputHeader getInputHeader()

Returns the access to the message header input parameters.

getInputParameters

InputParameters getInputParameters()

Returns the access to the import parameters which have been defined in the signature tab of the message mapping editor.

getInputAttachments

InputAttachments getInputAttachments()

getOutputHeader

OutputHeader getOutputHeader()

Returns the access to the message header output parameters.

getOutputParameters

OutputParameters getOutputParameters()

Returns the access to the export parameters which have been defined in the signature tab of the message mapping editor.

getTrace

AbstractTrace getTrace()

Returns the mapping trace object.

getParameters

Map getParameters()

Deprecated. use getInputParameters() instead

Returns a map with all input parameters. Left for compatibility with old mapping API

getOutputAttachments

OutputAttachments getOutputAttachments()

copyInputAttachments

void copyInputAttachments()