SAP ABAP Class /IWBEP/CL_MGW_VOCAN_MODEL (Vocabulary Annotation Model)
Hierarchy
☛
SAP_GWFND (Software Component) SAP Gateway Foundation
⤷
OPU-BSE-SDE (Application Component) Gateway SAP Data Enablement
⤷
/IWBEP/MGW_MED_IMPLEMENTATIONS (Package) OData Channel - Metadata - Implementations
⤷
⤷
Meta Relationship - Using
| # | Relationship type | Using | Short Description | Created on |
|---|---|---|---|---|
| 1 | Interface implementation (CLASS c. INTERFACES i_ref) | /IWBEP/IF_MGW_VOCAN_MODEL | Vocabulary Annotation Model - API to define Annoations | 20130220 |
Properties
| Class | /IWBEP/CL_MGW_VOCAN_MODEL | |
| Short Description | Vocabulary Annotation Model | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | /IWBEP/MGW_MED_IMPLEMENTATIONS | OData Channel - Metadata - Implementations |
| Created | 20130220 | 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 interface (INTERFACE i DEFINITION DEF... | Forward declaration interface (INTERFACE i DEFINITION DEF... |
Interfaces
| # | Interface | Abstract | Final | Description | Created on |
|---|---|---|---|---|---|
| 1 | /IWBEP/IF_MGW_VOCAN_MODEL | Vocabulary Annotation Model - API to define Annoations | 20130220 |
Friends
Class /IWBEP/CL_MGW_VOCAN_MODEL 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) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_MODEL | All data of the vocabulary annotation model | 20130221 | |||
| 2 | Instance attribute | Private | Type reference (TYPE) | INT4 | Counter used to calculate entity IDs | 20130304 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | Instance method | Private | Method | Calculates a new entity ID | 20130221 | |
| 2 | Instance method | Public | Constructor | CONSTRUCTOR | 20130221 | |
| 3 | Instance method | Public | Method | Creates a Vocabulary Annotation | 20130221 | |
| 4 | Instance method | Private | Method | Creates a Vocabulary Annotations Target | 20130221 | |
| 5 | Instance method | Public | Method | Creates a Vocabulary Annotation Collection | 20130221 | |
| 6 | Instance method | Public | Method | Creates a Vocabulary Annotation Function | 20130222 | |
| 7 | Instance method | Public | Method | Creates a Vocabulary Annotation Function Parameter | 20130222 | |
| 8 | Instance method | Public | Method | Creates a Vocabulary Annotation Function | 20130225 | |
| 9 | Instance method | Public | Method | Creates a Vocabulary Annotation Property | 20130221 | |
| 10 | Instance method | Public | Method | Creates a Vocabulary Annotation Record | 20130221 | |
| 11 | Instance method | Public | Method | Creates a Vocabulary Annotation Simple Value | 20130221 | |
| 12 | Instance method | Public | Method | Creates a Vocabulary Annotation URL | 20130225 | |
| 13 | Instance method | Public | Method | Get the Vocabulary Annotation data as a deep structure | 20130221 |
Events
Class /IWBEP/CL_MGW_VOCAN_MODEL has no event.
Types
Class /IWBEP/CL_MGW_VOCAN_MODEL has no local type.
Method Signatures
Method CALCULATE_ENTITY_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | RV_ENTITY_ID | Value transfer | Type reference (TYPE) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_E_MED_ENTITY_ID | New Entity ID | 20130221 |
Method CALCULATE_ENTITY_ID on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CONSTRUCTOR Signature
Method CONSTRUCTOR on class /IWBEP/CL_MGW_VOCAN_MODEL has no parameter.
Method CONSTRUCTOR on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_ANNOTATION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_ANNO_TARGET_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_ANN_TARGET | Reference to the data of the parent Annotation Target | 20130221 | |||
| 2 | IV_QUALIFIER | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_QUALIFIER | Vocabulary Annotations Target | 20130221 | |||
| 3 | IV_TERM | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_TERM | Target: The Element a Vocabulary Annotation points to | 20130221 | |||
| 4 | RO_ANNOTATION | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_ANNOTATION | Vocabulary Annotation | 20130221 |
Method CREATE_ANNOTATION on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_ANNOTATIONS_TARGET Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IV_QUALIFIER | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_QUALIFIER | Vocabulary Annotations Target | 20130225 | |||
| 2 | IV_TARGET | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_TARGET | Target: The Element a Vocabulary Annotation points to | 20130221 | |||
| 3 | RO_ANNOTATIONS_TARGET | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_ANN_TARGET | Vocabulary Annotations Target | 20130221 |
Method CREATE_ANNOTATIONS_TARGET on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_COLLECTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_ANNOTATION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_ANNOTATION | Reference to the data of the parent Annotation | 20130221 | |||
| 2 | IR_PARENT_LABEL_ELEM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_LABEL_ELEM | Reference to the data of the parent Labeled Element | 20130225 | |||
| 3 | IR_PARENT_PROPERTY_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_PROPERTY | Reference to the data of the parent Property | 20130222 | |||
| 4 | RO_COLLECTION | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_COLLECTION | Vocabulary Annotation Collection | 20130221 |
Method CREATE_COLLECTION on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_FUNCTION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_ANNOTATION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_ANNOTATION | Reference to the data of the parent Annotation | 20130222 | |||
| 2 | IR_PARENT_FUN_PARAM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_FUN_PARAM | Reference to the data of the parent Record | 20130222 | |||
| 3 | IR_PARENT_LABEL_ELEM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_LABEL_ELEM | Reference to the data of the parent Labeled Element | 20130225 | |||
| 4 | IR_PARENT_PROPERTY_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_PROPERTY | Reference to the data of the parent Property | 20130222 | |||
| 5 | IR_PARENT_URL_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_URL | Reference to the data of the parent URL | 20130225 | |||
| 6 | IV_FUNCTION_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_FUN_NAME | Vocabulary Annotation Function Name | 20130222 | |||
| 7 | RO_FUNCTION | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_FUNCTION | Vocabulary Annotation Function | 20130222 |
Method CREATE_FUNCTION on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_FUN_PARAMETER Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_FUNCTION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_FUNCTION | Reference to the data of the parent Function | 20130222 | |||
| 2 | RO_FUNCTION_PARAMETER | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_FUN_PARAM | Vocabulary Annotation Function Parameter | 20130222 |
Method CREATE_FUN_PARAMETER on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_LABELED_ELEMENT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_ANNOTATION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_ANNOTATION | Reference to the data of the parent Annotation | 20130225 | |||
| 2 | IR_PARENT_FUN_PARAM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_FUN_PARAM | Reference to the data of the parent Record | 20130225 | |||
| 3 | IV_LABEL_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_LABEL | Vocabulary Annotation Label Name | 20130225 | |||
| 4 | RO_LABELED_ELEMENT | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_LABEL_ELEM | Vocabulary Annotation Labeled Element | 20130225 |
Method CREATE_LABELED_ELEMENT on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_PROPERTY Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_RECORD_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_RECORD | Reference to the data of the parent Record | 20130221 | |||
| 2 | IV_PROPERTY_NAME | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_PROP_NAME | Vocabulary Annotation Property Name | 20130221 | |||
| 3 | RO_PROPERTY | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_PROPERTY | Vocabulary Annotation Property | 20130221 |
Method CREATE_PROPERTY on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_RECORD Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_ANNOTATION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_ANNOTATION | Reference to the data of the parent Annotation | 20130221 | |||
| 2 | IR_PARENT_COLLECTION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_COLLECTION | Reference to the data of the parent Collection | 20130221 | |||
| 3 | IR_PARENT_LABEL_ELEM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_LABEL_ELEM | Reference to the data of the parent Labeled Element | 20130225 | |||
| 4 | IR_PARENT_PROPERTY_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_PROPERTY | Reference to the data of the parent Property | 20130221 | |||
| 5 | IV_RECORD_TYPE | Call by reference | Type reference (TYPE) | /IWBEP/MGW_MED_VOCAN_RECO_TYPE | Type of a Vocabulary Annotation Record | 20130221 | |||
| 6 | RO_RECORD | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_RECORD | Vocabulary Annotation Record | 20130221 |
Method CREATE_RECORD on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_SIMPLE_VALUE Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_ANNOTATION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_ANNOTATION | Reference to the data of the parent Annotation | 20130222 | |||
| 2 | IR_PARENT_COLLECTION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_COLLECTION | Reference to the data of the parent Collection | 20130221 | |||
| 3 | IR_PARENT_FUN_PARAM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_FUN_PARAM | Reference to the data of the parent Function Parameter | 20130222 | |||
| 4 | IR_PARENT_LABEL_ELEM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_LABEL_ELEM | Reference to the data of the parent Labeled Element | 20130225 | |||
| 5 | IR_PARENT_PROPERTY_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_PROPERTY | Reference to the data of the parent Property | 20130221 | |||
| 6 | IR_PARENT_URL_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_URL | Reference to the data of the parent URL | 20130225 | |||
| 7 | RO_SIMPLE_VALUE | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_SIMPLE_VAL | Vocabulary Annotation Simple Value | 20130221 |
Method CREATE_SIMPLE_VALUE on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method CREATE_URL Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | IR_PARENT_ANNOTATION_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_ANNOTATION | Reference to the data of the parent Annotation | 20130225 | |||
| 2 | IR_PARENT_LABEL_ELEM_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_LABEL_ELEM | Reference to the data of the parent Labeled Element | 20130225 | |||
| 3 | IR_PARENT_PROPERTY_DATA | Call by reference | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_PROPERTY | Reference to the data of the parent Property | 20130225 | |||
| 4 | RO_URL | Value transfer | Object reference (TYPE REF TO) | /IWBEP/IF_MGW_VOCAN_URL | Vocabulary Annotation URL | 20130225 |
Method CREATE_URL on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
Method GET_MODEL_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | ES_MODEL_DATA | Call by reference | Type reference (TYPE) | /IWBEP/IF_MGW_MED_ODATA_TYPES=>TY_S_VOCAN_MODEL | Vocabulary Annotation Model Data | 20130221 |
Method GET_MODEL_DATA on class /IWBEP/CL_MGW_VOCAN_MODEL has no exception.
History
| Last changed by/on | SAP | 20131127 |
| SAP Release Created in | 200 |