SAP ABAP Class CL_SRAPI_API_UTIL (API Utilities)
Hierarchy
☛
SAP_BASIS (Software Component) SAP Basis Component
⤷
BC-XI-IBD (Application Component) Integration Builder - Design
⤷
SAI_SREP_API (Package) API for Repository
SAP_BASIS (Software Component) SAP Basis Component⤷
BC-XI-IBD (Application Component) Integration Builder - Design⤷
SAI_SREP_API (Package) API for RepositoryProperties
| Class | CL_SRAPI_API_UTIL | |
| Short Description | API Utilities | |
| Super Class | ||
| Instantiability of a Class | 0 | Private |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | SAI_SREP_API | API for Repository |
| Created | 20040914 | SAP |
| Last change | 20100113 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_SRAPI_API_UTIL has no forward declaration.
Interfaces
Class CL_SRAPI_API_UTIL has no interface implemented.
Friends
Class CL_SRAPI_API_UTIL has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ACTION |
Constant | Public | Type reference (TYPE) | STRING | 'processstep' | XiTypeID of Action | 20090715 | |
| 2 | ADAPTERMETADATA |
Constant | Public | Type reference (TYPE) | STRING | 'AdapterMetaData' | XiTypeId of Adapter Metadata | 20090715 | |
| 3 | AGENT |
Constant | Public | Type reference (TYPE) | STRING | 'agent' | XiTypeID of Agent | 20090715 | |
| 4 | ALERTCAT |
Constant | Public | Type reference (TYPE) | STRING | 'AlertCategory' | XiTypeID of Alert Category | 20090715 | |
| 5 | ATTRTYPE |
Constant | Public | Type reference (TYPE) | STRING | 'arisattribute' | XiTypeID of Attribute Type | 20090715 | |
| 6 | ATTRTYPEGP |
Constant | Public | Type reference (TYPE) | STRING | 'arisattrgroup' | XiTypeID of Attribute Type Group | 20090715 | |
| 7 | BO |
Constant | Public | Type reference (TYPE) | STRING | 'BO_Object' | XiTypeID of Business Object | 20090715 | |
| 8 | BOENH |
Constant | Public | Type reference (TYPE) | STRING | 'BO_Enh' | XiTypeID of Business Object Enhancement | 20090715 | |
| 9 | COMMCHANNELTEMPLATE |
Constant | Public | Type reference (TYPE) | STRING | 'ChannelTemplate' | XiTypeID of Communication Channel Template | 20090715 | |
| 10 | COMMFILE |
Constant | Public | Type reference (TYPE) | STRING | 'ariscommonfile' | XiTypeID of Common File | 20090715 | |
| 11 | CONTEXTOBJ |
Constant | Public | Type reference (TYPE) | STRING | 'ifmcontobj' | XiTypeID of Context Object | 20090715 | |
| 12 | DATATYPE |
Constant | Public | Type reference (TYPE) | STRING | 'ifmtypedef' | XiTypeID of Data Type | 20090715 | |
| 13 | DATATYPEENH |
Constant | Public | Type reference (TYPE) | STRING | 'ifmtypeenh' | XiTypeID of Data Type Enhancement | 20090715 | |
| 14 | EXTERNALDEF |
Constant | Public | Type reference (TYPE) | STRING | 'ifmextdef' | XiTypeID of External Definition | 20090715 | |
| 15 | FALSE |
Constant | Public | Type reference (TYPE) | BOOLEAN | '-' | Boolean Variable (X=true, -=false, space=unknown) | 20040914 | |
| 16 | FALSE_STRING |
Constant | Public | Type reference (TYPE) | STRING | 'false' | False | 20060126 | |
| 17 | FAULTMSGTYPE |
Constant | Public | Type reference (TYPE) | STRING | 'ifmfaultm' | XiTypeID of Fault Message Type | 20090715 | |
| 18 | FILTER |
Constant | Public | Type reference (TYPE) | STRING | 'arisfilter' | XiTypeID of Filter | 20090715 | |
| 19 | FONTFORMAT |
Constant | Public | Type reference (TYPE) | STRING | 'arisfssheet' | XiTypeID of Font Format | 20090715 | |
| 20 | FUNCLIB |
Constant | Public | Type reference (TYPE) | STRING | 'FUNC_LIB' | XiTypeID of Functional Library | 20090715 | |
| 21 | IDOC |
Constant | Public | Type reference (TYPE) | STRING | 'idoc' | XiTypeID of IDoc | 20090715 | |
| 22 | IMPARCH |
Constant | Public | Type reference (TYPE) | STRING | 'TRAFO_JAR' | XiTypeID of Imported Archive | 20090715 | |
| 23 | INTEGPROCESS |
Constant | Public | Type reference (TYPE) | STRING | 'RepBProcess' | XiTypeID of Integration Process | 20090715 | |
| 24 | MACRO |
Constant | Public | Type reference (TYPE) | STRING | 'arismacro' | XiTypeID of Macro | 20090715 | |
| 25 | MAPPTEMP |
Constant | Public | Type reference (TYPE) | STRING | 'MAP_TEMPLATE' | XiTypeID of Mapping Template | 20090715 | |
| 26 | MESSMAPP |
Constant | Public | Type reference (TYPE) | STRING | 'XI_TRAFO' | XiTypeID of Message Mapping | 20090715 | |
| 27 | MODEL |
Constant | Public | Type reference (TYPE) | STRING | 'arismodel' | XiTypeID of Model | 20090715 | |
| 28 | MODELTYPE |
Constant | Public | Type reference (TYPE) | STRING | 'arismodeltype' | XiTypeID of Model Type | 20090715 | |
| 29 | MONITPROCESS |
Constant | Public | Type reference (TYPE) | STRING | 'RepBAMProcess' | XiTypeID of Monitoring Process | 20090715 | |
| 30 | MSGTYPE |
Constant | Public | Type reference (TYPE) | STRING | 'ifmmessage' | XiTypeID of Message Type | 20090715 | |
| 31 | OBJDEF |
Constant | Public | Type reference (TYPE) | STRING | 'arisobjdef' | XiTypeID of Object Definition | 20090715 | |
| 32 | OPMAPP |
Constant | Public | Type reference (TYPE) | STRING | 'MAPPING' | XiTypeID of Operation Mapping | 20090715 | |
| 33 | PROCESSCOMP |
Constant | Public | Type reference (TYPE) | STRING | 'processcomp' | XiTypeId of Process Component | 20090715 | |
| 34 | PROCESSINTSC |
Constant | Public | Type reference (TYPE) | STRING | 'process' | XiTypeID of Process Integration Scenario | 20090715 | |
| 35 | REPORT |
Constant | Public | Type reference (TYPE) | STRING | 'arisreport' | XiTypeID of Report | 20090715 | |
| 36 | REP_TERM_CODE |
Constant | Public | Type reference (TYPE) | CHAR30 | 'Code' | Representation Term: Code | 20050613 | |
| 37 | RFC |
Constant | Public | Type reference (TYPE) | STRING | 'rfc' | XiTypeID of Function Module | 20090715 | |
| 38 | SERVICEINT |
Constant | Public | Type reference (TYPE) | STRING | 'ifmmessif' | XiTypeID of Service Interface | 20090715 | |
| 39 | STEPGROUP |
Constant | Public | Type reference (TYPE) | STRING | 'RepPATProcess' | XiTypeID of Step Group | 20090715 | |
| 40 | SYMBOL |
Constant | Public | Type reference (TYPE) | STRING | 'arissymbol' | XiTypeID of Symbol | 20090715 | |
| 41 | TEMPLATE |
Constant | Public | Type reference (TYPE) | STRING | 'aristemplate' | XiTypeID of Template | 20090715 | |
| 42 | TRUE |
Constant | Public | Type reference (TYPE) | BOOLEAN | 'X' | Boolean Variable (X=true, -=false, space=unknown) | 20040914 | |
| 43 | TRUE_STRING |
Constant | Public | Type reference (TYPE) | STRING | 'true' | True | 20060126 | |
| 44 | UITEXT |
Constant | Public | Type reference (TYPE) | STRING | 'ifmuitexts' | XiTypeID of UI Text Object | 20090715 | |
| 45 | UITEXTVAR |
Constant | Public | Type reference (TYPE) | STRING | 'ifmuitexvars' | XiTypeID of UI Text Variants | 20090715 | |
| 46 | WEBPUBFILE |
Constant | Public | Type reference (TYPE) | STRING | 'ariswpfile' | XiTypeID of WebPublisher File | 20090715 | |
| 47 | WEBPUBSCRIPT |
Constant | Public | Type reference (TYPE) | STRING | 'ariswpscript' | XiTypeID of WebPublisher Script | 20090715 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | BOOLEAN_TO_STRING |
Static method | Public | Method | Convert Boolean value to string value (X=true, -=false) | 20090126 |
| 2 | CREATE_RESPONSE_DOCUMENT |
Static method | Public | Method | Converts XString to XML (cl_proxy_xsd_node) | 20090710 |
| 3 | EXTRACT_LOCAL_SWCV |
Static method | Public | Method | Extract Locally Installed SWCVs | 20041019 |
| 4 | EXTRACT_LOCAL_SWCV_INTERNAL |
Static method | Private | Method | Extract locally installed SWCVs (internal) | 20060623 |
| 5 | EXTRACT_LOCAL_SWCV_STRUC |
Static method | Public | Method | Extract locally installed SWCVs (as flat structures) | 20060623 |
| 6 | GET_ALL_QUERYABLE_TYPES |
Static method | Public | Method | Gets all object types available from API | 20040914 |
| 7 | GET_LOG_HANDLE |
Static method | Public | Method | Given the object and subobject, returns Log Handle | 20090121 |
| 8 | GET_OBJECT_SCREEN_NAME |
Static method | Public | Method | Converts XiTypeID to Screen Name | 20090720 |
| 9 | GET_PIC_CHECKS_SUPPORTED_TYPES |
Static method | Public | Method | Return all types for which PIC checks are supported | 20090121 |
| 10 | GET_PROXY_GENERATED_TYPES |
Static method | Public | Method | Gets all object types for which proxies can be generated | 20090121 |
| 11 | GET_RESULT_ATTRIBUTES |
Static method | Public | Method | Gets result attributes for a type | 20040917 |
| 12 | LOG |
Static method | Public | Method | Save and Commit DB Logs | 20090121 |
| 13 | PARSE_CHANGELIST_USERS |
Static method | Public | Method | Utility method to parse XML and get changelist users | 20090710 |
Events
Class CL_SRAPI_API_UTIL has no event.
Types
Class CL_SRAPI_API_UTIL has no local type.
Method Signatures
Method BOOLEAN_TO_STRING Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IM_BOOL_VAL | Call by reference | Type reference (TYPE) | BOOLEAN | boolsche Variable (X=true, -=false, space=unknown) | 20090126 | ||
| 2 |  Returning |
RESULT | Value transfer | Type reference (TYPE) | STRING | 20090126 |
Method BOOLEAN_TO_STRING on class CL_SRAPI_API_UTIL has no exception.
Method CREATE_RESPONSE_DOCUMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_SER_OUTPUT | Call by reference | Type reference (TYPE) | XSTRING | 20090710 | |||
| 2 | Returning |
RESULT | Value transfer | Object reference (TYPE REF TO) | CL_PROXY_XSD_NODE | Proxy-Generierung: Knoten in einem WSDL-/XML-Schema-Dokument | 20090710 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_SRAPI_REP_API_ERROR |
Exception Rep API | 20090710 |
Method EXTRACT_LOCAL_SWCV Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALLCOMPONENTS | Call by reference | Type reference (TYPE) | SRAPI_T_SOFTWARE_COMP_VERSION | Softwarecomponentenversionen | 20041019 | ||
| 2 | Importing |
FILTER_SWCV_FOR_CLIENT | Call by reference | Type reference (TYPE) | BOOLEAN | Flag to filter SWCV for client based on table SRAPI_SWC_DEST | 20080313 | ||
| 3 | Importing |
IM_CLIENT | Call by reference | Type reference (TYPE) | MANDT | Client | 20080313 | ||
| 4 | Returning |
LOCALCOMPONENTS | Value transfer | Type reference (TYPE) | SRAPI_T_SOFTWARE_COMP_VERSION | Softwarecomponentenversionen | 20041019 |
Method EXTRACT_LOCAL_SWCV on class CL_SRAPI_API_UTIL has no exception.
Method EXTRACT_LOCAL_SWCV_INTERNAL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALL_COMPONENTS | Call by reference | Type reference (TYPE) | SRAPI_T_SOFTWARE_COMP_VERSION | Softwarecomponentenversionen | 20060623 | ||
| 2 | Importing |
ALL_COMPONENTS_STRUC | Call by reference | Type reference (TYPE) | PRX_T_COMP | Proxy-Generierung: Query-Daten: Komponenten | 20060623 | ||
| 3 |  Exporting |
LOCAL_COMPONENTS | Call by reference | Type reference (TYPE) | SRAPI_T_SOFTWARE_COMP_VERSION | Softwarecomponentenversionen | 20060623 | ||
| 4 | Exporting |
LOCAL_COMPONENTS_STRUC | Call by reference | Type reference (TYPE) | PRX_T_COMP | Komponenten | 20060623 |
Method EXTRACT_LOCAL_SWCV_INTERNAL on class CL_SRAPI_API_UTIL has no exception.
Method EXTRACT_LOCAL_SWCV_STRUC Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
ALL_COMPONENTS | Call by reference | Type reference (TYPE) | PRX_T_COMP | Softwarekomponenten | 20060623 | ||
| 2 | Exporting |
LOCAL_COMPONENTS | Call by reference | Type reference (TYPE) | PRX_T_COMP | Softwarekomponenten | 20060623 |
Method EXTRACT_LOCAL_SWCV_STRUC on class CL_SRAPI_API_UTIL has no exception.
Method GET_ALL_QUERYABLE_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_RESULT | Call by reference | Type reference (TYPE) | SRAPI_T_STRING | Objekttypen | 20040914 |
Method GET_ALL_QUERYABLE_TYPES on class CL_SRAPI_API_UTIL has no exception.
Method GET_LOG_HANDLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_OBJECT | Call by reference | Type reference (TYPE) | STRING | 20090121 | |||
| 2 | Importing |
IM_SUBOBJECT | Call by reference | Type reference (TYPE) | STRING | 20090121 | |||
| 3 | Exporting |
RESULT | Call by reference | Type reference (TYPE) | BALLOGHNDL | Anwendungs-Log: Handle eines Protokolls | 20090121 |
Method GET_LOG_HANDLE on class CL_SRAPI_API_UTIL has no exception.
Method GET_OBJECT_SCREEN_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_TYPEID | Call by reference | Type reference (TYPE) | STRING | 20090720 | |||
| 2 | Returning |
RESULT | Value transfer | Type reference (TYPE) | STRING | 20090720 |
Method GET_OBJECT_SCREEN_NAME on class CL_SRAPI_API_UTIL has no exception.
Method GET_PIC_CHECKS_SUPPORTED_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_RESULT | Call by reference | Type reference (TYPE) | SRAPI_T_STRING | Tabelle mit Stringeinträgen | 20090121 |
Method GET_PIC_CHECKS_SUPPORTED_TYPES on class CL_SRAPI_API_UTIL has no exception.
Method GET_PROXY_GENERATED_TYPES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_RESULT | Call by reference | Type reference (TYPE) | SRAPI_T_STRING | Tabelle mit Stringeinträgen | 20090121 |
Method GET_PROXY_GENERATED_TYPES on class CL_SRAPI_API_UTIL has no exception.
Method GET_RESULT_ATTRIBUTES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Exporting |
EX_RESULT | Call by reference | Type reference (TYPE) | SRAPI_T_STRING | Tabelle mit Stringeinträgen | 20040917 | ||
| 2 | Importing |
IM_TYPE | Call by reference | Type reference (TYPE) | STRING | Objekttyp | 20040917 |
Method GET_RESULT_ATTRIBUTES on class CL_SRAPI_API_UTIL has no exception.
Method LOG Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_LOG_HNDL | Call by reference | Type reference (TYPE) | BALLOGHNDL | Anwendungs-Log: Handle eines Protokolls | 20090121 | ||
| 2 | Importing |
IM_MESSAGES | Call by reference | Type reference (TYPE) | SRAPI_T_LOG_MESSAGE | 20090121 |
Method LOG on class CL_SRAPI_API_UTIL has no exception.
Method PARSE_CHANGELIST_USERS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IM_SER_OUTPUT | Call by reference | Type reference (TYPE) | XSTRING | 20090710 | |||
| 2 | Returning |
RESULT | Value transfer | Type reference (TYPE) | SRAPI_T_STRING | Tabelle mit Stringeinträgen | 20090710 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_SRAPI_REP_API_ERROR |
Exception Rep API | 20090710 |
History
| Last changed by/on | SAP | 20100113 |
| SAP Release Created in | 700 |
