SAP ABAP Class /IWBEP/CL_MGW_MED_DBA_VOCAN (Data Access to Vocabulary Annotation)
Hierarchy
☛
SAP_GWFND (Software Component) SAP Gateway Foundation
⤷
OPU-BSE-SDE (Application Component) Gateway SAP Data Enablement
⤷
/IWBEP/MGW_MED_PERSISTENCY (Package) OData Channel - Metadata - Backend Registration Persistency
⤷
⤷
Properties
| Class | /IWBEP/CL_MGW_MED_DBA_VOCAN | |
| Short Description | Data Access to Vocabulary Annotation | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /IWBEP/MGW_MED_PERSISTENCY | OData Channel - Metadata - Backend Registration Persistency |
| Created | 20130408 | SAP |
| Last change | 20131127 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
| # | Type group / Object type | Type | Type Description |
|---|---|---|---|
| 1 | Forward declaration class (CLASS c DEFINITION DEFERRED) | Forward declaration class (CLASS c DEFINITION DEFERRED) | |
| 2 | Type group use (TYPE-POOLS tp) | Type group use (TYPE-POOLS tp) |
Interfaces
Class /IWBEP/CL_MGW_MED_DBA_VOCAN has no interface implemented.
Friends
Class /IWBEP/CL_MGW_MED_DBA_VOCAN has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Instance attribute | Private | Type reference (TYPE) | XSDBOOLEAN | 20130409 | ||||
| 2 | Static Attribute | Private | Type reference (TYPE) | /IWBEP/MED_VA_FILE_TECH_NAME | Technical Vocabulary Annotation File Name | 20130409 | |||
| 3 | Static Attribute | Private | Type reference (TYPE) | /IWBEP/MED_VA_FILE_VERSION | Vocabulary Annotation File Version | 20130409 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Public | Method | Assign a vocabulary annotation to service | 20130408 | |
| 2 | Instance method | Public | Method | Check existence of a vocabulary annotation | 20130409 | |
| 3 | Instance method | Public | Method | Create a vocabulary annotation | 20130410 | |
| 4 | Instance method | Public | Method | Delete a vocabulary annotation | 20130410 | |
| 5 | Static method | Public | Method | Get all registered vocabulary annotations | 20130410 | |
| 6 | Static method | Public | Method | Get all vocabulary annotations of a service | 20130410 | |
| 7 | Static method | Public | Method | Get a DBA instance | 20130408 | |
| 8 | Instance method | Public | Method | Get detail of a vocabulary annotation | 20130409 | |
| 9 | Instance method | Public | Method | Get assigned services | 20130410 | |
| 10 | Instance method | Public | Method | Lock a vocabulary annotation | 20130408 | |
| 11 | Instance method | Public | Method | Set main service for a vocabulary annotation | 20130409 | |
| 12 | Instance method | Public | Method | Unassign a vocabulary annotation from service | 20130408 | |
| 13 | Instance method | Public | Method | Unlock a vocabulary annotation | 20130408 | |
| 14 | Instance method | Public | Method | Update a vocabulary annotation | 20130408 |
Events
Class /IWBEP/CL_MGW_MED_DBA_VOCAN has no event.
Types
| # | Type | Visibility | Typing | Associated Type | Description | Created on | Type Source |
|---|---|---|---|---|---|---|---|
| 1 | TY_S_VOCAN_DETAIL | Public | See coding | 20130409 | BEGIN OF ty_s_vocan_detail,
technical_name TYPE /iwbep/i_mgw_vah-technical_name,
version TYPE /iwbep/i_mgw_vah-version,
class_name TYPE /iwbep/i_mgw_vah-class_name,
created_by TYPE /iwbep/i_mgw_vah-created_by,
changed_by TYPE /iwbep/i_mgw_vah-changed_by,
created_timestmp TYPE /iwbep/i_mgw_vah-created_timestmp,
changed_timestmp TYPE /iwbep/i_mgw_vah-changed_timestmp,
language TYPE /iwbep/i_mgw_vat-language,
description TYPE /iwbep/i_mgw_vat-description,
services TYPE ty_t_vocan_service,
END OF ty_s_vocan_detail
|
||
| 2 | TY_S_VOCAN_HEADER | Public | See coding | 20130410 | BEGIN OF ty_s_vocan_header,
technical_name TYPE /iwbep/i_mgw_vah-technical_name,
version TYPE /iwbep/i_mgw_vah-version,
END OF ty_s_vocan_header
|
||
| 3 | TY_S_VOCAN_SERVICE | Public | See coding | 20130410 | BEGIN OF ty_s_vocan_service,
serv_tech_name TYPE /iwbep/med_grp_technical_name,
serv_version TYPE /iwbep/med_grp_version,
is_main_service TYPE /iwbep/med_va_is_life_control,
serv_alias TYPE /iwbep/med_va_serv_ref_alias,
END OF ty_s_vocan_service
|
||
| 4 | TY_T_VOCAN_DETAIL | Public | See coding | 20130409 | ty_t_vocan_detail TYPE STANDARD TABLE OF ty_s_vocan_detail WITH DEFAULT KEY
|
||
| 5 | TY_T_VOCAN_HEADER | Public | See coding | 20130410 | ty_t_vocan_header TYPE STANDARD TABLE OF ty_s_vocan_header WITH DEFAULT KEY
|
||
| 6 | TY_T_VOCAN_SERVICE | Public | See coding | 20130410 | ty_t_vocan_service TYPE STANDARD TABLE OF ty_s_vocan_service WITH DEFAULT KEY
|
Method Signatures
Method ASSIGN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_IS_MAIN_SERVICE | Call by reference | Type reference (TYPE) | /IWBEP/MED_VA_IS_LIFE_CONTROL | ABAP_TRUE | Annotation file's life cycle is controlled by this Service | 20130408 | ||
| 2 | IV_SERV_ALIAS | Call by reference | Type reference (TYPE) | /IWBEP/MED_VA_SERV_REF_ALIAS | Vocabulary Annotation Service Namespace Alias | 20130408 | |||
| 3 | IV_SERV_TECH_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_TECHNICAL_NAME | Technical Service Name | 20130408 | |||
| 4 | IV_SERV_VERSION | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_VERSION | Service Version | 20130408 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Meta data exception | 20130408 |
Method CHECK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_VALUE | Value transfer | Type reference (TYPE) | XSDBOOLEAN | X: Exists | 20130409 |
Method CHECK on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no exception.
Method CREATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CLASS_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_DEFINITION_CLASS | Model Provider Class (MPC) | 20130410 | |||
| 2 | IV_DESCRIPTION | Call by reference | Type reference (TYPE) | /IWBEP/MED_DESCRIPTION | Description | 20130410 | |||
| 3 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | Language Key | 20130410 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Meta data exception | 20130410 |
Method DELETE Signature
Method DELETE on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Meta data exception | 20130410 |
Method GET_ALL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_VOCAN_DETAIL | Call by reference | Type reference (TYPE) | TY_T_VOCAN_DETAIL | 20130410 |
Method GET_ALL on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no exception.
Method GET_HEADER_BY_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_VOCAN_HEADER | Call by reference | Type reference (TYPE) | TY_T_VOCAN_HEADER | Data Access to Vocabulary Annotation | 20130410 | |||
| 2 | IV_SERV_TECH_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_TECHNICAL_NAME | Technical Service Name | 20130410 | |||
| 3 | IV_SERV_VERSION | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_VERSION | Service Version | 20130410 |
Method GET_HEADER_BY_SERVICE on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no exception.
Method GET_INSTANCE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_VOCAN_TECH_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_VA_FILE_TECH_NAME | Technical Vocabulary Annotation File Name | 20130409 | |||
| 2 | IV_VOCAN_VERSION | Call by reference | Type reference (TYPE) | /IWBEP/MED_VA_FILE_VERSION | Vocabulary Annotation File Version | 20130409 | |||
| 3 | RO_MED_DBA_VOCAN | Value transfer | Object reference (TYPE REF TO) | /IWBEP/CL_MGW_MED_DBA_VOCAN | Data Access to Vocabulary Annotation | 20130409 |
Method GET_INSTANCE on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no exception.
Method GET_VOCAN_DETAIL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RS_VOCAN_DETAIL | Value transfer | Type reference (TYPE) | TY_S_VOCAN_DETAIL | 20130409 |
Method GET_VOCAN_DETAIL on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no exception.
Method GET_VOCAN_SERVICES Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ET_VOCAN_SERVICE | Call by reference | Type reference (TYPE) | TY_T_VOCAN_SERVICE | 20130410 |
Method GET_VOCAN_SERVICES on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no exception.
Method LOCK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | Language Key | 20130408 | |||
| 2 | IV_SERV_TECH_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_TECHNICAL_NAME | Technical Service Name | 20130408 | |||
| 3 | IV_SERV_VERSION | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_VERSION | Service Version | 20130408 | |||
| 4 | IV_WAIT | Call by reference | Type reference (TYPE) | XSDBOOLEAN | ABAP_FALSE | 20130408 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Meta data exception | 20130408 |
Method SET_MAIN_SERVICE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SERV_TECH_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_TECHNICAL_NAME | Technical Service Name | 20130409 | |||
| 2 | IV_SERV_VERSION | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_VERSION | Service Version | 20130409 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Meta data exception | 20130409 |
Method UNASSIGN Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_SERV_TECH_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_TECHNICAL_NAME | Technical Service Name | 20130408 | |||
| 2 | IV_SERV_VERSION | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_VERSION | Service Version | 20130408 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Meta data exception | 20130408 |
Method UNLOCK Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | Language Key | 20130408 | |||
| 2 | IV_SERV_TECH_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_TECHNICAL_NAME | Technical Service Name | 20130408 | |||
| 3 | IV_SERV_VERSION | Call by reference | Type reference (TYPE) | /IWBEP/MED_GRP_VERSION | Service Version | 20130408 |
Method UNLOCK on class /IWBEP/CL_MGW_MED_DBA_VOCAN has no exception.
Method UPDATE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_CLASS_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MED_DEFINITION_CLASS | Meta Data Definition Class | 20130408 | |||
| 2 | IV_DESCRIPTION | Call by reference | Type reference (TYPE) | /IWBEP/MED_DESCRIPTION | Description | 20130408 | |||
| 3 | IV_LANGUAGE | Call by reference | Type reference (TYPE) | LANGU | Language Key | 20130408 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | Meta data exception | 20130408 |
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 200 |