consolut - CL_APL_ECATT_PARAMS - Parameter Definition for Test Data

CL_APL_ECATT_PARAMS - Parameter Definition for Test Data

Fill RESBD Structure from EBP Component Structure Fill RESBD Structure from EBP Component Structure
This documentation is copyright by SAP AG.

Functionality

General

Objects of the object type CL_APL_ECATT_PARAMS contain lists of eCATT parameters with their definitions and values.

The definition of an eCATT parameter specifies, among other things,

its reference type. References to internal ABAP types, structures, data elements, and tables definedin the ABAP Dictionary of an R/3 System are all valid. This enables parameters to have deep structures - that is, they may contain several subcomponents.

Each defined parameter contains a default value.

Variants of parameters can also be defined. Each parameter contains one parameter value in each of its variants.

Instantiation

Objects of the type CL_APL_ECATT_PARAMS are usually as part of other eCATT objects and are saved andread with these in the database. This means that if an object of the type CL_APL_ECATT_MODULE or CL_APL_ECATT_TEST_DATAexists, its attribute PARAMS should also be instantiated. The method GET_PARAM_DEF would then be accessed as follows:

,,DATA: my_ecatt TYPE REF TO CL_APL_ECATT_MODULE,

,, tmp_var TYPE REF TO CL_APL_ECATT_OBJECT.

,,...

,,CALL METHOD CL_APL_ECATT_MODULE=>SHOW_OBJECT

,,,,,,,,EXPORTING ...

,,,,,,,,IMPORTING tmp_var.

,,my_ecatt ?= tmp_var.

,,CALL METHOD my_ecatt->params->GET_PARAM_DEF

,,,,,,,,EXPORTING ...

,,,,,,,,IMPORTING ... .

Structured Parameters

Structured parameters are stored in XML files.

A parameter is defined in its structure by a reference to an object defined in the ABAP Dictionary.This structure is mapped in an XML schema file and saved according to the eCATT parameter definition. The values of the variants of this type of parameter are stored in XML data files.

You can create an initial XML template from the XML schema file to maintain the XML data file and use it.

The XML schema of a parameter is implicitly created when all SET_PARAM_DEF methods are called.

An XML data file is created when GET_PARAM_VALUE is first accessed.

Both XML schema data and XML data files are stored persistently in eCATT tables. This procedure anticipatesthe later access by remote systems to Dictionary information. In this situation the persistent information,instead of the current information from the remote system, can be used if there is a breakdown in the connection to the remote system.

Public Methods

CONSTRUCTOR

Parameter processing

GET_PARAM_DEF	Selective read-access to an
individual parameter definition
GET_PARAM_VALUE	Selective read access to an
individual parameter value


GET_PARAMS_DEF	Selective read access to several
parameter definitions in one call
GET_PARAMS_VALUES	Selective read access to several
parameter values in one call


GET_PARAMS	Read access to all
parameters (definition + default value) in one call


SET_PARAM_DEF	Write access to several
parameter definitions
SET_PARAM_VALUE	Write access for several
parameter contents (default value + variants)


SET_PARAMS	Write access for several
parameters (definition + default value)


PARAM_EXISTS	Existence check for parameter

CHECK_DATA	Checks parameters, reads all
Reference types, texts, ...

CHECK_PARAM_NAMES	Checks that parameter names are correct

DELETE_ALL_PARAMETERS	Deletes all parameters (not in database)
DELETE_PARAMETER	Deletes individual parameters (not in database)


Variant maintenance

! ! ! Variant processing is still not been changed and enhanced ! ! !


ADD_VARIANT	Create variant
REMOVE_VARIANT	Delete variant
RENAME_VARIANT	Rename variant
VARIANT_EXISTS	Check existence of variant

Object processing parameter object

DELETE	Delete parameter definitions and values in database
deletion
READ	Read from database
SAVE	Save in database

Protected Methods


SET_PARAM_XML_DATA	Generates XML data object,
(from READ_XML_DATA used internally)
SET_PARAM_DEF_INTERNAL	Sets parameter definitions internally
SET_PARAM_XML_SCHEME	Updates instances of CL_APL_ECATT_XML_SCHEME

CREATE_VARIANT	Create variant

GET_PARAM_XML_DATA	Gets values of structured parameters
GET_PINDEX	Reads value of field PINDEX from
parameter definition

READ_XML_DATA	Reads XML data of structured
parameters from DB
READ_XML_SCHEMES	Reads XML schemas of structured
parameters from DB
SAVE_PARAM_DEF	Saves parameter definitions
SAVE_PARAM_VAL	Saves parameter values
PREPARE_XML_SAVING	Formats XML stream for saving

RAISE_CX_ECATT_APL_PARAM	Triggers exception CX_ECATT_APL_PARAM

UPDATE_PARAM_XML_DATA	Updates XML_DATA Reference in ITab PARAM_VAL_TAB
UPDATE_TYPE_REF	Reads attributes of type reference from DDIC

Attributes

Public attributes

PARAM_TAB	Internal table of parameter definitions
PARAM_VAL_TAB	Internal table of parameter values

Protected Attributes

CONTAINER	Reference to eCATT object
that contains this parameter object
DB_TAB_NAME_PAR	Name of database table
for parameter definitions
DB_TAB_NAME_VAL	Name of database table
for parameter values
DB_TAB_NAME_PAR_XML	Name der Datenbanktabelle der
Parameter values for XML parameters
PINDEX	Maximum parameter index