SAP ABAP Class CL_OST_GEN_WS (Manages a web service within Open Service Tool)
Hierarchy
☛
WEBCUIF (Software Component) SAP Web UI Framework
⤷
CA-WUI-WST (Application Component) Web Services Tool
⤷
WS_BOL_DT (Package) Web Service Tool> Design Time
⤷
⤷
Properties
| Class | CL_OST_GEN_WS | |
| Short Description | Manages a web service within Open Service Tool | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | WS_BOL_DT | Web Service Tool> Design Time |
| Created | 20060705 | SAP |
| Last change | 20100303 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) | |
| 2 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) |
Interfaces
Class CL_OST_GEN_WS has no interface implemented.
Friends
Class CL_OST_GEN_WS has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Constant | Public | Type reference (TYPE) | STRING | 'BASIC' | Security profile with basic authentication | 20060728 | ||
| 2 | Constant | Public | Type reference (TYPE) | STRING | 'SECURE' | Secury profile for secure communication | 20060728 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Static method | Public | Method | Creates a web service for a given function group | 20060705 | |
| 2 | Static method | Public | Method | Deletes a Web Service Definition | 20060705 | |
| 3 | Static method | Public | Method | Releases web service at runtime | 20060711 | |
| 4 | Static method | Private | Method | Fills expert mapping table with custom service field names | 20080818 | |
| 5 | Static method | Private | Method | Fill parameter table for dyn call of web service creation | 20070813 | |
| 6 | Static method | Private | Method | 20091116 | ||
| 7 | Static method | Public | Method | First character for a name within customer space | 20060816 | |
| 8 | Static method | Private | Method | Get expert mapping name for node | 20080702 | |
| 9 | Static method | Public | Method | Returns URL to web service homepage | 20060804 | |
| 10 | Static method | Public | Method | Returns the available values for security profiles | 20060705 | |
| 11 | Static method | Protected | Method | Returns web service key | 20060803 | |
| 12 | Static method | Public | Method | returns the web service name for given service object name | 20060725 | |
| 13 | Static method | Public | Method | Returns URL to WSDL | 20060803 | |
| 14 | Static method | Public | Method | Checks if prefix is in customer area | 20060816 |
Events
Class CL_OST_GEN_WS has no event.
Types
Class CL_OST_GEN_WS has no local type.
Method Signatures
Method CREATE_WEB_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_BAPIRETURN | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20060707 | |||
| 2 | I_AFTERIMPORT | Call by reference | Type reference (TYPE) | BOOLEAN | ' ' | Afterimport processing? | 20070806 | ||
| 3 | I_CORRNUM | Call by reference | Type reference (TYPE) | TRKORR | Request/Task | 20070403 | |||
| 4 | I_DEVCLASS | Call by reference | Type reference (TYPE) | DEVCLASS | Package | 20060711 | |||
| 5 | I_FUNCTION_GROUP_NAME | Call by reference | Type reference (TYPE) | RS38L-AREA | Name of Function Module Group | 20060707 | |||
| 6 | I_OBJECT_TYPE | Call by reference | Type reference (TYPE) | BSP_DLC_OBJECT_TYPE | UI Object Type | 20060814 | |||
| 7 | I_PROFILE | Call by reference | Type reference (TYPE) | STRING | security profile | 20060707 | |||
| 8 | I_RELEASE_WS_RUNTIME | Call by reference | Type reference (TYPE) | BOOLEAN | 'X' | deploy web service for runtime | 20060911 | ||
| 9 | I_SHORT_TEXT | Call by reference | Type reference (TYPE) | VEPTEXT | Short Description | 20060707 | |||
| 10 | I_SUPPRESS_DIALOG | Call by reference | Type reference (TYPE) | BOOLEAN | 'X' | Boolean Variable (X=True, -=False, Space=Unknown) | 20070131 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for static office intergration exceptions | 20070423 |
Method DELETE_WEB_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_BAPIRETURN | Call by reference | Type reference (TYPE) | BAPIRETTAB | Table with BAPI Return Information | 20070822 | |||
| 2 | E_BAPIRETURN | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20060707 | |||
| 3 | I_AFTERIMPORT | Call by reference | Type reference (TYPE) | BOOLEAN | ' ' | 20070813 | |||
| 4 | I_OBJECT_TYPE | Call by reference | Type reference (TYPE) | BSP_DLC_OBJECT_TYPE | Web Service Object Identifier | 20060814 | |||
| 5 | I_OBJECT_USAGE | Call by reference | Type reference (TYPE) | CRM_OST_OBJECT_USAGE | Object Usage | 20070404 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for static office intergration exceptions | 20070423 |
Method DEPLOY_WEB_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_BAPIRETURN | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20060711 | |||
| 2 | I_WS_NAME | Call by reference | Type reference (TYPE) | VEPNAME | Name of a Service Definition | 20060711 |
Method DEPLOY_WEB_SERVICE on class CL_OST_GEN_WS has no exception.
Method FILL_EXPERT_MAPPING_TABLE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | BSP_DLC_OBJECT_TYPE | UI Object Type | 20080818 | |||
| 2 | RT_EXPERT_MAPPING | Value transfer | Type reference (TYPE) | CL_WS_EXPERT_MAPPING=>T_EXP_MAPPING | 20080818 |
Method FILL_EXPERT_MAPPING_TABLE on class CL_OST_GEN_WS has no exception.
Method FILL_PARAMETER_TABLE_CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ETAB | Call by reference | Type reference (TYPE) | ABAP_EXCPBIND_TAB | 20070813 | ||||
| 2 | ET_PTAB | Call by reference | Type reference (TYPE) | ABAP_PARMBIND_TAB | 20070813 | ||||
| 3 | IT_EXPERT_MAPPING | Call by reference | Type reference (TYPE) | CL_WS_EXPERT_MAPPING=>T_EXP_MAPPING | 20090728 | ||||
| 4 | IV_CORR_INSERT | Call by reference | Type reference (TYPE) | VICORRINSERT | Delegate Data to RS_CORR_INSERT | 20070813 | |||
| 5 | IV_DEFAULT_MAPPING | Call by reference | Type reference (TYPE) | CHAR1 | Virtual Interface: Flag for Mapping Names | 20070813 | |||
| 6 | IV_DEFINITION_START_POINT | Call by reference | Type reference (TYPE) | DEF_START_PT | 20091116 | ||||
| 7 | IV_ENDPOINT | Call by reference | Type reference (TYPE) | VEPREFTO | Reference to Development Object (End Point) | 20070813 | |||
| 8 | IV_ENDPOINT_TYPE | Call by reference | Type reference (TYPE) | VEPREFTYPE | Object Type of Reference Object (Function, BAPI, IDOC) | 20070813 | |||
| 9 | IV_NAME | Call by reference | Type reference (TYPE) | VEPNAME | Name of a Service Definition | 20070813 | |||
| 10 | IV_NO_TRANSPORT | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20070813 | |||
| 11 | IV_SHORT_TEXT | Call by reference | Type reference (TYPE) | VEPTEXT | Short Description | 20070813 | |||
| 12 | IV_WSD_DEPLOY | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20070813 | |||
| 13 | IV_WSD_NAME | Call by reference | Type reference (TYPE) | WEBSNAME | Variant Name | 20070813 | |||
| 14 | IV_WSD_PROFILE | Call by reference | Type reference (TYPE) | STRING | 20070813 |
Method FILL_PARAMETER_TABLE_CREATE on class CL_OST_GEN_WS has no exception.
Method FILL_PARAMETER_TABLE_DELETE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_ETAB | Call by reference | Type reference (TYPE) | ABAP_EXCPBIND_TAB | 20091116 | ||||
| 2 | ET_PTAB | Call by reference | Type reference (TYPE) | ABAP_PARMBIND_TAB | 20091116 | ||||
| 3 | IT_DEPENDENT_OBJECTS | Call by reference | Type reference (TYPE) | WSUI_TREE_T | 20091116 | ||||
| 4 | IV_NO_TRANSPORT | Call by reference | Type reference (TYPE) | BOOLEAN | 20091116 | ||||
| 5 | IV_OBJECT_ID | Call by reference | Type reference (TYPE) | CHAR32 | Character field, length 32 | 20091116 | |||
| 6 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | CHAR10 | Character Field Length = 10 | 20091116 | |||
| 7 | IV_ONLY_FIRST_LEVEL | Call by reference | Type reference (TYPE) | BOOLEAN | 20091116 | ||||
| 8 | IV_WITHOUT_SAVE | Call by reference | Type reference (TYPE) | BOOLEAN | 20091116 |
Method FILL_PARAMETER_TABLE_DELETE on class CL_OST_GEN_WS has no exception.
Method GET_CUST_NAME_PREFIX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EP_PREFIX | Call by reference | Type reference (TYPE) | OBJ_NAMERE | Generic Entry of Protected Namespace (Lowercase) | 20060816 |
Method GET_CUST_NAME_PREFIX on class CL_OST_GEN_WS has no exception.
Method GET_EXPERT_MAPPING_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IT_EXPERT_MAPPING | Call by reference | Type reference (TYPE) | CL_WS_EXPERT_MAPPING=>T_EXP_MAPPING | 20080702 | ||||
| 2 | IV_OWN_TYPE | Call by reference | Type reference (TYPE) | STRUKNAME | Name of a structure | 20080702 | |||
| 3 | RV_NAME | Value transfer | Type reference (TYPE) | STRING | 20080702 |
Method GET_EXPERT_MAPPING_NAME on class CL_OST_GEN_WS has no exception.
Method GET_TESTPAGE_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_BAPIRETURN | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20060804 | |||
| 2 | E_TESTUI_URL | Call by reference | Type reference (TYPE) | STRING | 20060804 | ||||
| 3 | I_WS_NAME | Call by reference | Type reference (TYPE) | VEPNAME | Name of a Service Definition | 20060804 |
Method GET_TESTPAGE_URL on class CL_OST_GEN_WS has no exception.
Method GET_VALUES_FOR_PROFILE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RT_VALUE | Value transfer | Type reference (TYPE) | BSP_WD_DROPDOWN_TABLE | Value Table for BSP WD Dropdown List Boxes | 20060705 |
Method GET_VALUES_FOR_PROFILE on class CL_OST_GEN_WS has no exception.
Method GET_WEB_SERVICE_KEY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_BAPIRETURN | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20060803 | |||
| 2 | E_WS_KEY | Call by reference | Type reference (TYPE) | SRT_REGISTRY_WSKEY | SRT Registry: Web Service Release Key | 20060803 | |||
| 3 | I_WS_NAME | Call by reference | Type reference (TYPE) | VEPNAME | Name of a Service Definition | 20060803 |
Method GET_WEB_SERVICE_KEY on class CL_OST_GEN_WS has no exception.
Method GET_WEB_SERVICE_NAME Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_WS_NAME | Call by reference | Type reference (TYPE) | VEPNAME | Name of a Service Definition | 20060725 | |||
| 2 | IV_OBJECT_TYPE | Call by reference | Type reference (TYPE) | BSP_DLC_OBJECT_TYPE | UI Object Type | 20060725 | |||
| 3 | IV_OBJECT_USAGE | Call by reference | Type reference (TYPE) | CRM_OST_OBJECT_USAGE | Object Usage | 20070419 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Base class for static office intergration exceptions | 20070423 |
Method GET_WSDL_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | E_BAPIRETURN | Call by reference | Type reference (TYPE) | BAPIRET2 | Return Parameter | 20060803 | |||
| 2 | E_WSDL_URL | Call by reference | Type reference (TYPE) | STRING | URL to WSDL file | 20060803 | |||
| 3 | I_WS_NAME | Call by reference | Type reference (TYPE) | VEPNAME | Name of a Service Definition | 20060803 |
Method GET_WSDL_URL on class CL_OST_GEN_WS has no exception.
Method IS_CUST_PREFIX Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | EV_IS_CUST_PREFIX | Call by reference | Type reference (TYPE) | BOOLEAN | Boolean Variable (X=True, -=False, Space=Unknown) | 20060816 | |||
| 2 | IV_PREFIX | Call by reference | Type reference (TYPE) | OBJ_NAMERE | Generic Entry of Protected Namespace (Lowercase) | 20060816 |
Method IS_CUST_PREFIX on class CL_OST_GEN_WS has no exception.
History
| Last changed by/on | SAP | 20100303 |
| SAP Release Created in | 510 |