SAP ABAP Interface IF_APL_ECATT_API_PARAMS (Interface for API to eCATT Objects with Parameters)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-TWB-TST-ECA (Application Component) eCATT Extended Computer Aided Test Tool
⤷
SECATT_API_ENG (Package) eCATT - Application Programming Interface
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-TWB-TST-ECA (Application Component) eCATT Extended Computer Aided Test Tool⤷
SECATT_API_ENG (Package) eCATT - Application Programming Interface
Meta Relationship - Used By
| # | Relationship type | Used by | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface composition (i COMPRISING i_ref) | IF_APL_ECATT_SCRIPT_API | Interface for API to eCATT Test Script | 20120925 |
| 2 | Interface composition (i COMPRISING i_ref) | IF_APL_ECATT_TC_API | Interface for API to eCATT Test Configuration | 20120925 |
| 3 | Interface implementation (CLASS c. INTERFACES i_ref) | CL_APL_ECATT_PARAMS_API | API Class for eCATT - Parameter and Variant Usage | 20110615 |
Properties
| Interface | IF_APL_ECATT_API_PARAMS | |
| Short Description | Interface for API to eCATT Objects with Parameters |
General Data
| Package | SECATT_API_ENG | eCATT - Application Programming Interface |
| Created | 20110615 | SAP |
| Last changed | 20140121 | SAP |
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | CL_APL_ECATT_CONST | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | IF_APL_ECATT_API | Interface for API eCATT Object | 20110615 |
Friends
Interface IF_APL_ECATT_API_PARAMS has no friend.
Attributes
Interface IF_APL_ECATT_API_PARAMS has no attribute.
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | CHECK_PARAMETER_EXIST |
Instance method | Public | Method | Check Existence of a Parameter | 20110927 |
| 2 | CHECK_PARAMETER_TYPE |
Instance method | Public | Method | Check Parameter Type simple or structured | 20110927 |
| 3 | CREATE_DATA_REF |
Instance method | Public | Method | Create Parameter Data Reference | 20110615 |
| 4 | GET_DEFAULT_VARIANT |
Instance method | Public | Method | Get Default Variant data | 20110927 |
| 5 | GET_PARAMS |
Instance method | Public | Method | Get Parameter List | 20110927 |
| 6 | GET_PARAM_DEFINITION |
Instance method | Public | Method | Get Parameter Definition | 20110615 |
| 7 | GET_PARAM_NAMES |
Instance method | Public | Method | Get Parameter Names List | 20110927 |
| 8 | GET_VALUE |
Instance method | Public | Method | Get Parameter Value | 20110615 |
| 9 | GET_VALUE_INTERNAL |
Instance method | Public | Method | Get Parameter Value internal | 20110927 |
| 10 | SET_VALUE |
Instance method | Public | Method | Set Parameter Value | 20110615 |
| 11 | SET_VALUE_INTERNAL |
Instance method | Public | Method | Set parameter Value internal | 20110927 |
Events
Interface IF_APL_ECATT_API_PARAMS has no event.
Types
Interface IF_APL_ECATT_API_PARAMS has no local type.
Method Signatures
Method CHECK_PARAMETER_EXIST Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
I_PARAM_NAME | Call by reference | Type reference (TYPE) | ETP_NAME | Parameter Name | 20110930 | ||
| 2 |  Returning |
R_EXISTS | Value transfer | Type reference (TYPE) | ETONOFF | eCATT Switch On/Off | 20110927 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_ECATT_API |
Exception Class for eCATT API | 20110927 |
Method CHECK_PARAMETER_TYPE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_PARAM_NAME | Call by reference | Type reference (TYPE) | ETP_NAME | Name of a Parameter or Command Interface | 20111003 | ||
| 2 | Returning |
RE_SIMPLE | Value transfer | Type reference (TYPE) | ETONOFF | eCATT Switch On/Off | 20110927 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110927 |
Method CREATE_DATA_REF Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Changing |
C_VALUE_ID | Call by reference | Type reference (TYPE) | STRING | Id in data object server | 20130218 | ||
| 2 |  Exporting |
E_DATA_REF | Call by reference | Type reference (TYPE) | DATA | Data reference on created ABAP data | 20111003 | ||
| 3 | Importing |
I_DATA_DEF | Value transfer | Type reference (TYPE) | STRING | type for data declaration | 20111003 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110615 |
Method GET_DEFAULT_VARIANT Signature
Method GET_DEFAULT_VARIANT on Interface IF_APL_ECATT_API_PARAMS has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110927 |
Method GET_PARAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ETPAR_TAB | Value transfer | Type reference (TYPE) | ETPAR_GUI_TABTYPE | Table for Exchanging Parameters: GUI - APL | 20120411 | ||
| 2 | Importing |
I_GET_SCRIPT_CMD_INTF | Call by reference | Type reference (TYPE) | ETONOFF | SPACE | Get also Command Interfaces (special parameters) | 20121126 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110927 |
Method GET_PARAM_DEFINITION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
E_PARAM_DEF | Value transfer | Type reference (TYPE) | STRING | 20110615 | |||
| 2 | Importing |
I_PARAM_NAME | Call by reference | Type reference (TYPE) | ETP_NAME | Name of a Parameter or Command Interface | 20110615 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110615 |
Method GET_PARAM_NAMES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Returning |
ET_PARAM_TAB | Value transfer | Type reference (TYPE) | ETP_NAME_TABTYPE | Table of parameter names | 20111011 | ||
| 2 | Importing |
I_GET_SCRIPT_CMD_INTF | Call by reference | Type reference (TYPE) | ETONOFF | SPACE | Test script: X = Get command interfaces in addition | 20121126 | |
| 3 | Importing |
I_SORTORDER | Call by reference | Type reference (TYPE) | ETONOFF | 'X' | Sequence X=as defined by sort; A=alphabetic | 20110927 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20111003 |
Method GET_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
E_PARAM_VALUE | Value transfer | Type reference (TYPE) | ANY | Variable to which the Value should be Transferred | 20110615 | ||
| 2 | Importing |
I_PARAM_NAME | Call by reference | Type reference (TYPE) | ETPAR_NAME | Name of Parameter for eCATT Data Container | 20110615 | ||
| 3 | Importing |
I_PATH | Call by reference | Type reference (TYPE) | STRING | Path within Parameter | 20110615 | ||
| 4 | Importing |
I_VARIANT_NAME | Call by reference | Type reference (TYPE) | ETVAR_ID | 'ECATTDEFAULT' | Variant name | 20110615 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110615 |
Method GET_VALUE_INTERNAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Changing |
E_PARAM_REF | Value transfer | Type reference (TYPE) | DATA | REF of the Variable to which the Value should be Transferred | 20110927 | ||
| 2 | Importing |
I_PARAM_NAME | Call by reference | Type reference (TYPE) | ETPAR_NAME | Parameter name | 20110927 | ||
| 3 | Importing |
I_PATH | Call by reference | Type reference (TYPE) | STRING | Path within Parameter down to leaf node | 20110927 | ||
| 4 | Importing |
I_VARIANT_NAME | Call by reference | Type reference (TYPE) | ETVAR_ID | Variant name | 20110927 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110927 |
Method SET_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_PARAM_NAME | Call by reference | Type reference (TYPE) | ETPAR_NAME | Name of Parameter for eCATT Data Container | 20110615 | ||
| 2 | Importing |
I_PARAM_VALUE | Value transfer | Type reference (TYPE) | ANY | Variable from which the value is to be copied from | 20110615 | ||
| 3 | Importing |
I_PATH | Call by reference | Type reference (TYPE) | STRING | Path within the Parameter | 20110615 | ||
| 4 | Importing |
I_VARIANT_NAME | Call by reference | Type reference (TYPE) | ETVAR_ID | 'ECATTDEFAULT' | Variant name | 20110615 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110615 |
Method SET_VALUE_INTERNAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
I_PARAM_NAME | Call by reference | Type reference (TYPE) | ETPAR_NAME | Name of Parameter for eCATT Data Container | 20110927 | ||
| 2 | Importing |
I_PARAM_REF | Value transfer | Type reference (TYPE) | DATA | REF to the Variable from which the Value is Transferred | 20110927 | ||
| 3 | Importing |
I_PATH | Call by reference | Type reference (TYPE) | STRING | Path within the Parameter | 20110927 | ||
| 4 | Importing |
I_VARIANT_NAME | Call by reference | Type reference (TYPE) | ETVAR_ID | 'ECATTDEFAULT' | Variant name | 20110927 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_ECATT_API |
Exception Class for eCATT API | 20110927 |
History
| Last changed by/on | SAP | 20140121 |
| SAP Release Created in | 731 |
