SAP ABAP Class CL_VBC_MODEL_FACTORY (Factory for Visual Business Models)
Hierarchy
☛
SAP_BS_FND (Software Component) SAP Business Suite Foundation
⤷
CA-GTF-VBZ (Application Component) Visual Business
⤷
VBC_BUSINESS_OBJECTS (Package) Business Object Layer (Application Logic)
SAP_BS_FND (Software Component) SAP Business Suite Foundation⤷
CA-GTF-VBZ (Application Component) Visual Business⤷
VBC_BUSINESS_OBJECTS (Package) Business Object Layer (Application Logic)Properties
| Class | CL_VBC_MODEL_FACTORY | |
| Short Description | Factory for Visual Business Models | |
| Super Class | ||
| Instantiability of a Class | 2 | Public |
| Final |
General Data
| Message Class | ||
| Program status | ||
| Category | 0 | |
| Package | VBC_BUSINESS_OBJECTS | Business Object Layer (Application Logic) |
| Created | 20081111 | SAP |
| Last change | 20110908 | SAP |
| Shared Memory-enabled | ||
| Fixed point arithmetic | ||
| Unicode checks active |
Forward declarations
Class CL_VBC_MODEL_FACTORY has no forward declaration.
Interfaces
Class CL_VBC_MODEL_FACTORY has no interface implemented.
Friends
Class CL_VBC_MODEL_FACTORY has no friend class.
Attributes
| # | Attribute | Level | Visibility | Read only | Typing | Associated Type | Initial Value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | MC_DATA_OBJECTS_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'DataObjects' | Stream ID for Data Objects | 20090612 | |
| 2 | MC_DATA_OBJECTS_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'DATA_OBJECTS' | Model ID (Name) | 20090612 | |
| 3 | MC_MESSAGE_OBJECTS_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'MessageObjects' | Stream ID for Message Objects | 20091001 | |
| 4 | MC_MESSAGE_OBJECTS_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'APP_MESSAGE' | Model ID (Name) | 20091001 | |
| 5 | MC_MODEL_CONTEXT_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'Configuration' | Stream ID for Model Configuration/ Application Context | 20090612 | |
| 6 | MC_MODEL_CONTEXT_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'APP_CONTEXT' | Model ID (Name) | 20090612 | |
| 7 | MC_MODEL_METADATA_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'Metadata' | Stream ID for Model Structure XAML | 20090612 | |
| 8 | MC_MODEL_METADATA_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'APP_METADATA' | Model ID (Name) | 20090612 | |
| 9 | MC_MODEL_PERS_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'Personalization' | Stream ID for Model Personalizations | 20090612 | |
| 10 | MC_MODEL_PERS_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'APP_PERSONALIZATION' | Model ID (Name) | 20090612 | |
| 11 | MC_MODEL_STRUCTURE_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'Structure' | Stream ID for Model Structure XAML | 20090612 | |
| 12 | MC_MODEL_STRUCTURE_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'APP_STRUCTURE' | Model ID (Name) | 20090612 | |
| 13 | MC_MODEL_TEXTS_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'Localization' | Stream ID for Model Texts | 20090612 | |
| 14 | MC_MODEL_TEXTS_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'APP_TEXTS' | Model ID (Name) | 20090612 | |
| 15 | MC_VISUAL_OBJECTS_NAME |
Constant | Public | Type reference (TYPE) | VBC_STREAM_ID | 'VisualObjects' | Stream ID for Visual Objects | 20090612 | |
| 16 | MC_VISUAL_OBJECTS_TECH_ID |
Constant | Public | Type reference (TYPE) | VBC_PROPERTY_CONTAINER_ID | 'VISUAL_OBJECTS' | Model ID (Name) | 20090612 | |
| 17 | MC_ZIP_INDEX_FILE_NAME |
Constant | Private | Type reference (TYPE) | STRING | '[Content_Types].xml' | 20090722 | ||
| 18 | MO_MODEL |
Instance attribute | Private | Object reference (TYPE REF TO) | IF_VBC_MODEL | Model to be created | 20081112 | ||
| 19 | MT_XML_STREAM |
Instance attribute | Private | Type reference (TYPE) | VBC_T_XSTREAM | XString Stream Table | 20081112 | ||
| 20 | MV_CREATE_METADATA_VERSION |
Instance attribute | Private | Type reference (TYPE) | VBC_BOOLEAN | SPACE | Set the Version from Metadata XML | 20081120 | |
| 21 | MV_CREATE_NEW_VERSION |
Instance attribute | Private | Type reference (TYPE) | VBC_BOOLEAN | SPACE | Flag for creating a new major model version | 20081112 | |
| 22 | MV_DELETE_OLD_CONTENT |
Instance attribute | Private | Type reference (TYPE) | VBC_BOOLEAN | SPACE | Delete Old Model Content (no Update) | 20081120 |
Methods
| # | Method | Level | Visibility | Method type | Description | Created on |
|---|---|---|---|---|---|---|
| 1 | ASSEMBLE_NEW_REVISION |
Instance method | Public | Method | Assemble updated objects into a new revision | 20091123 |
| 2 | CHECK_COMPLETENESS |
Instance method | Private | Method | Check if all expected files are available | 20081112 |
| 3 | CLEAN_FACTORY |
Instance method | Public | Method | Reset internal Attributes | 20081117 |
| 4 | CONVERT_CONTAINER_IN_STREAM_ID |
Static method | Public | Method | Convert container ID in corresponding stream ID (file name) | 20090609 |
| 5 | CONVERT_STREAM_IN_CONTAINER_ID |
Static method | Public | Method | Convert stream ID into corresponding stream ID | 20090609 |
| 6 | EXTRACT_ZIP_INTO_STREAMS |
Static method | Public | Method | Extract list of streams from zip file | 20091116 |
| 7 | GET_FROM_XML |
Instance method | Public | Method | Create a full Model Instance from the XML Files | 20081117 |
| 8 | GET_FROM_ZIP |
Instance method | Public | Method | Create a full Model Instance from a ZIP File | 20081125 |
| 9 | GET_MODEL_BY_ID |
Instance method | Public | Method | Load a model from the database (by ID) | 20081117 |
| 10 | GET_MODEL_ID_FROM_XML |
Static method | Public | Method | Read model ID out of streams | 20091116 |
| 11 | GET_MODEL_ID_FROM_ZIP |
Static method | Public | Method | Read model ID out of zip | 20091116 |
| 12 | GET_NULL_OBJECT |
Instance method | Public | Method | Create an empty model | 20081113 |
| 13 | PARSE_CONTAINER_XMLS |
Instance method | Private | Method | Generically Create Container Object | 20081119 |
| 14 | PARSE_MODEL_STRUCTURE_XML |
Instance method | Private | Method | Parse the main XAML File for the Model | 20081112 |
| 15 | UPDATE_META_DATA |
Instance method | Private | Method | Update the metadata from a given structure | 20091111 |
Events
Class CL_VBC_MODEL_FACTORY has no event.
Types
Class CL_VBC_MODEL_FACTORY has no local type.
Method Signatures
Method ASSEMBLE_NEW_REVISION Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 |  Importing |
IO_MODEL | Call by reference | Object reference (TYPE REF TO) | IF_VBC_DOMAIN_OBJECT | Main Visual Business Model Interface | 20091123 | ||
| 2 |  Returning |
RO_MODEL | Value transfer | Object reference (TYPE REF TO) | IF_VBC_DOMAIN_OBJECT | Main Visual Business Model Interface | 20091123 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 |  CX_VBC_EXCEPTION |
Generic exception allowing for flexible texts | 20091123 |
Method CHECK_COMPLETENESS Signature
Method CHECK_COMPLETENESS on class CL_VBC_MODEL_FACTORY has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_MODEL_CREATION |
Model creation exception | 20081112 |
Method CLEAN_FACTORY Signature
Method CLEAN_FACTORY on class CL_VBC_MODEL_FACTORY has no parameter.
Method CLEAN_FACTORY on class CL_VBC_MODEL_FACTORY has no exception.
Method CONVERT_CONTAINER_IN_STREAM_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_CONTAINER_ID | Call by reference | Type reference (TYPE) | VBC_OBJECT_ID | Object Identifier (Name, Alias, Object, ...) | 20090609 | ||
| 2 | Returning |
RV_STREAM_ID | Value transfer | Type reference (TYPE) | VBC_STREAM_ID | Object Identifier (Name, Alias, Object, ...) | 20090609 |
Method CONVERT_CONTAINER_IN_STREAM_ID on class CL_VBC_MODEL_FACTORY has no exception.
Method CONVERT_STREAM_IN_CONTAINER_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_STREAM_ID | Call by reference | Type reference (TYPE) | VBC_STREAM_ID | Object Identifier (Name, Alias, Object, ...) | 20090609 | ||
| 2 | Returning |
RV_CONTAINER_ID | Value transfer | Type reference (TYPE) | VBC_OBJECT_ID | Object Identifier (Name, Alias, Object, ...) | 20090609 |
Method CONVERT_STREAM_IN_CONTAINER_ID on class CL_VBC_MODEL_FACTORY has no exception.
Method EXTRACT_ZIP_INTO_STREAMS Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ZIP_STREAM | Call by reference | Type reference (TYPE) | XSTRING | 20091116 | |||
| 2 | Returning |
RT_STREAMS | Value transfer | Type reference (TYPE) | VBC_T_XSTREAM | XString Stream Table | 20091116 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_EXCEPTION |
Generic exception allowing for flexible texts | 20091116 |
Method GET_FROM_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_XML_STREAM | Call by reference | Type reference (TYPE) | VBC_T_XSTREAM | XString Stream Table | 20081117 | ||
| 2 | Importing |
IV_CREATE_METADATA_VERSION | Call by reference | Type reference (TYPE) | VBC_BOOLEAN | SPACE | Set the Version from Metadata XML | 20081120 | |
| 3 | Importing |
IV_CREATE_NEW_VERSION | Call by reference | Type reference (TYPE) | VBC_BOOLEAN | SPACE | New major model version | 20081117 | |
| 4 | Importing |
IV_DELETE_OLD_CONTENT | Call by reference | Type reference (TYPE) | VBC_BOOLEAN | SPACE | Delete Old Model Content (no Update) | 20081120 | |
| 5 | Returning |
RO_MODEL | Value transfer | Object reference (TYPE REF TO) | IF_VBC_MODEL | Main Visual Business Model Interface | 20081117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_LATER_VERSION_EXISTS |
Specific Version Import failed cause oflater Version already | 20081120 | |
| 2 | CX_VBC_MODEL_CREATION |
Model creation exception | 20081117 |
Method GET_FROM_ZIP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ZIP_STREAM | Call by reference | Type reference (TYPE) | XSTRING | 20081201 | |||
| 2 | Returning |
RO_MODEL | Value transfer | Object reference (TYPE REF TO) | IF_VBC_MODEL | Main Visual Business Model Interface | 20081201 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_EXCEPTION |
Generic exception allowing for flexible texts | 20091105 | |
| 2 | CX_VBC_LATER_VERSION_EXISTS |
Specific Version Import failed cause oflater Version already | 20081201 | |
| 3 | CX_VBC_MODEL_CREATION |
Model creation exception | 20081201 |
Method GET_MODEL_BY_ID Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_MODEL_ID | Call by reference | Type reference (TYPE) | VBC_MODEL_ID | Model ID (Name) | 20081117 | ||
| 2 | Importing |
IV_MODEL_METADATA | Call by reference | Type reference (TYPE) | VBC_S_MODEL_METADATA | Model Metadata | 20090120 | ||
| 3 | Importing |
IV_VERSION | Call by reference | Type reference (TYPE) | VBC_VERSION | Version | 20081117 | ||
| 4 | Returning |
RO_MODEL | Value transfer | Object reference (TYPE REF TO) | IF_VBC_MODEL | Main Visual Business Model Interface | 20081117 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_NOT_FOUND |
Data not found exception | 20081117 |
Method GET_MODEL_ID_FROM_XML Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IT_XML_STREAM | Call by reference | Type reference (TYPE) | VBC_T_XSTREAM | XString Stream Table | 20091116 | ||
| 2 | Returning |
RV_MODEL_ID | Value transfer | Type reference (TYPE) | VBC_MODEL_ID | Model ID (Name) | 20091116 |
Method GET_MODEL_ID_FROM_XML on class CL_VBC_MODEL_FACTORY has no exception.
Method GET_MODEL_ID_FROM_ZIP Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_ZIP_STREAM | Call by reference | Type reference (TYPE) | XSTRING | 20091116 | |||
| 2 | Returning |
RV_MODEL_ID | Value transfer | Type reference (TYPE) | VBC_MODEL_ID | Model ID (Name) | 20091116 |
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_EXCEPTION |
Generic exception allowing for flexible texts | 20091116 |
Method GET_NULL_OBJECT Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IV_MODEL_ID | Call by reference | Type reference (TYPE) | VBC_MODEL_ID | Model ID (Name) | 20081113 | ||
| 2 | Returning |
RO_MODEL | Value transfer | Object reference (TYPE REF TO) | IF_VBC_MODEL | Main Visual Business Model Interface | 20081113 |
Method GET_NULL_OBJECT on class CL_VBC_MODEL_FACTORY has no exception.
Method PARSE_CONTAINER_XMLS Signature
Method PARSE_CONTAINER_XMLS on class CL_VBC_MODEL_FACTORY has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_MODEL_CREATION |
Model creation exception | 20090218 |
Method PARSE_MODEL_STRUCTURE_XML Signature
Method PARSE_MODEL_STRUCTURE_XML on class CL_VBC_MODEL_FACTORY has no parameter.
| # | Exception | Resumable | Description | Created on |
|---|---|---|---|---|
| 1 | CX_VBC_LATER_VERSION_EXISTS |
Specific Version Import failed cause oflater Version already | 20081120 | |
| 2 | CX_VBC_MODEL_CREATION |
Model creation exception | 20081112 |
Method UPDATE_META_DATA Signature
| # | Type | Parameter | Pass Value | Optional | Typing Method | Associated Type | Default value | Description | Created on |
|---|---|---|---|---|---|---|---|---|---|
| 1 | Importing |
IO_DOMAIN_OBJECT | Call by reference | Object reference (TYPE REF TO) | IF_VBC_DOMAIN_OBJECT | Domain Object Interface | 20091111 | ||
| 2 | Importing |
IO_MODEL | Call by reference | Object reference (TYPE REF TO) | IF_VBC_MODEL | Main Visual Business Model Interface | 20091111 | ||
| 3 | Importing |
IS_METADATA | Call by reference | Type reference (TYPE) | VBC_S_MODEL_METADATA | Model Metadata | 20091111 |
Method UPDATE_META_DATA on class CL_VBC_MODEL_FACTORY has no exception.
History
| Last changed by/on | SAP | 20110908 |
| SAP Release Created in | 702 |
