SAP ABAP Class CL_VBC_APPLICATION_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)

Properties

Class	CL_VBC_APPLICATION_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	20100527	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_VBC_APPLICATION_FACTORY has no forward declaration.

Interfaces

Class CL_VBC_APPLICATION_FACTORY has no interface implemented.

Friends

Class CL_VBC_APPLICATION_FACTORY has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_APP_CONTEXT_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'Configuration'		20100527
2	MC_APP_CONTEXT_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'APP_CONTEXT'		20100527
3	MC_APP_METADATA_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'Metadata'		20100527
4	MC_APP_METADATA_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'APP_METADATA'		20100527
5	MC_APP_PERS_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'Personalization'		20100527
6	MC_APP_PERS_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'APP_PERSONALIZATION'		20100527
7	MC_APP_STRUCTURE_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'Structure'		20100527
8	MC_APP_STRUCTURE_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'APP_STRUCTURE'		20100527
9	MC_APP_TEXTS_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'Localization'		20100527
10	MC_APP_TEXTS_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'APP_TEXTS'		20100527
11	MC_DATA_OBJECTS_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'DataObjects'	Stream ID for Data Objects	20100527
12	MC_DATA_OBJECTS_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'DATA_OBJECTS'	Model ID (Name)	20100527
13	MC_MESSAGE_OBJECTS_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'MessageObjects'	Stream ID for Message Objects	20100527
14	MC_MESSAGE_OBJECTS_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'APP_MESSAGE'	Model ID (Name)	20100527
15	MC_VISUAL_OBJECTS_NAME	Constant	Public	☐	Type reference (TYPE)	VBC_STREAM_ID	'VisualObjects'	Stream ID for Visual Objects	20100527
16	MC_VISUAL_OBJECTS_TECH_ID	Constant	Public	☐	Type reference (TYPE)	VBC_PROPERTY_CONTAINER_ID	'VISUAL_OBJECTS'	Model ID (Name)	20100527
17	MC_ZIP_INDEX_FILE_NAME	Constant	Private	☐	Type reference (TYPE)	STRING	'[Content_Types].xml'		20100527
18	MO_APP	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_VBC_APP			20100527
19	MT_XML_STREAM	Instance attribute	Private	☐	Type reference (TYPE)	VBC_T_XSTREAM		XString Stream Table	20100527
20	MV_CREATE_METADATA_VERSION	Instance attribute	Private	☐	Type reference (TYPE)	VBC_BOOLEAN	SPACE	Set the Version from Metadata XML	20100527
21	MV_CREATE_NEW_VERSION	Instance attribute	Private	☐	Type reference (TYPE)	VBC_BOOLEAN	SPACE	Flag for creating a new major model version	20100527
22	MV_DELETE_OLD_CONTENT	Instance attribute	Private	☐	Type reference (TYPE)	VBC_BOOLEAN	SPACE	Delete Old Model Content (no Update)	20100527

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CHECK_COMPLETENESS	Instance method	Private	Method	Check if all expected files are available	20100527
2	CLEAN_FACTORY	Instance method	Public	Method	Reset internal Attributes	20100527
3	CONVERT_CONTAINER_IN_STREAM_ID	Static method	Public	Method	Convert container ID in corresponding stream ID (file name)	20100527
4	CONVERT_STREAM_IN_CONTAINER_ID	Static method	Public	Method	Convert stream ID into corresponding stream ID	20100527
5	EXTRACT_ZIP_INTO_STREAMS	Static method	Public	Method	Extract list of streams from zip file	20100527
6	GET_APPLICATION_BY_ID	Instance method	Public	Method	Load a model from the database (by ID)	20100527
7	GET_APP_ID_FROM_XML	Static method	Public	Method		20100527
8	GET_APP_ID_FROM_ZIP	Static method	Public	Method		20100527
9	GET_CONTEXT_CONTAINER	Instance method	Public	Method	Get the context container for a given application ID	20100615
10	GET_FROM_XML	Instance method	Public	Method	Create a full Model Instance from the XML Files	20100527
11	GET_FROM_ZIP	Instance method	Public	Method	Create a full Model Instance from a ZIP File	20100527
12	GET_NULL_OBJECT	Instance method	Public	Method	Create an empty model	20100527
13	PARSE_APP_STRUCTURE_XML	Instance method	Private	Method		20100527
14	PARSE_CONTAINER_XMLS	Instance method	Private	Method	Generically Create Container Object	20100527
15	UPDATE_META_DATA	Instance method	Private	Method	Update the metadata from a given structure	20100527

Events

Class CL_VBC_APPLICATION_FACTORY has no event.

Types

Class CL_VBC_APPLICATION_FACTORY has no local type.

Method Signatures

Method CHECK_COMPLETENESS Signature

Method CHECK_COMPLETENESS on class CL_VBC_APPLICATION_FACTORY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_VBC_MODEL_CREATION	☐		20100527

Method CLEAN_FACTORY Signature

Method CLEAN_FACTORY on class CL_VBC_APPLICATION_FACTORY has no parameter.
Method CLEAN_FACTORY on class CL_VBC_APPLICATION_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, ...)	20100527
2	Returning	RV_STREAM_ID	Value transfer	☐	Type reference (TYPE)	VBC_STREAM_ID		Object Identifier (Name, Alias, Object, ...)	20100527

Method CONVERT_CONTAINER_IN_STREAM_ID on class CL_VBC_APPLICATION_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, ...)	20100527
2	Returning	RV_CONTAINER_ID	Value transfer	☐	Type reference (TYPE)	VBC_OBJECT_ID		Object Identifier (Name, Alias, Object, ...)	20100527

Method CONVERT_STREAM_IN_CONTAINER_ID on class CL_VBC_APPLICATION_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			20100527
2	Returning	RT_STREAMS	Value transfer	☐	Type reference (TYPE)	VBC_T_XSTREAM		XString Stream Table	20100527

#	Exception	Resumable	Description	Created on
1	CX_VBC_EXCEPTION	☐	Generic exception allowing for flexible texts	20100527

Method GET_APPLICATION_BY_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APP_ID	Call by reference	☐	Type reference (TYPE)	VBC_APP_ID		Model ID (Name)	20100527
2	Importing	IV_APP_METADATA	Call by reference	☑	Type reference (TYPE)	VBC_S_APP_METADATA		Model Metadata	20100527
3	Importing	IV_VERSION	Call by reference	☑	Type reference (TYPE)	VBC_VERSION		Version	20100527
4	Returning	RO_APPLICATION	Value transfer	☐	Object reference (TYPE REF TO)	IF_VBC_APP		Main Visual Business Model Interface	20100527

#	Exception	Resumable	Description	Created on
1	CX_VBC_NOT_FOUND	☐	Data not found exception	20100527

Method GET_APP_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			20100527
2	Returning	RV_APP_ID	Value transfer	☐	Type reference (TYPE)	VBC_APP_ID			20100527

Method GET_APP_ID_FROM_XML on class CL_VBC_APPLICATION_FACTORY has no exception.

Method GET_APP_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			20100527
2	Returning	RV_APP_ID	Value transfer	☐	Type reference (TYPE)	VBC_APP_ID			20100527

#	Exception	Resumable	Description	Created on
1	CX_VBC_EXCEPTION	☐		20100527

Method GET_CONTEXT_CONTAINER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APP_ID	Call by reference	☐	Type reference (TYPE)	VBC_APP_ID		Visual Business Application Identifier	20100615
2	Importing	IV_VERSION	Call by reference	☑	Type reference (TYPE)	VBC_VERSION		Version	20100615
3	Returning	RO_CONTAINER	Value transfer	☐	Object reference (TYPE REF TO)	IF_VBC_PROPERTY_CONTAINER		Model Property Container (VOs, DOs...)	20100615

#	Exception	Resumable	Description	Created on
1	CX_VBC_NOT_FOUND	☐	Data not found exception	20100622

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	20100527
2	Importing	IV_CREATE_METADATA_VERSION	Call by reference	☐	Type reference (TYPE)	VBC_BOOLEAN	SPACE	Set the Version from Metadata XML	20100527
3	Importing	IV_CREATE_NEW_VERSION	Call by reference	☐	Type reference (TYPE)	VBC_BOOLEAN	SPACE	New major model version	20100527
4	Importing	IV_DELETE_OLD_CONTENT	Call by reference	☐	Type reference (TYPE)	VBC_BOOLEAN	SPACE	Delete Old Model Content (no Update)	20100527
5	Returning	RO_APP	Value transfer	☐	Object reference (TYPE REF TO)	IF_VBC_APP			20100527

#	Exception	Resumable	Description	Created on
1	CX_VBC_LATER_VERSION_EXISTS	☐	Specific Version Import failed cause oflater Version already	20100527
2	CX_VBC_MODEL_CREATION	☐		20100527

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			20100527
2	Returning	RO_APP	Value transfer	☐	Object reference (TYPE REF TO)	IF_VBC_APP			20100527

#	Exception	Resumable	Description	Created on
1	CX_VBC_EXCEPTION	☐	Generic exception allowing for flexible texts	20100527
2	CX_VBC_LATER_VERSION_EXISTS	☐	Specific Version Import failed cause oflater Version already	20100527
3	CX_VBC_MODEL_CREATION	☐		20100527

Method GET_NULL_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_APP_ID	Call by reference	☐	Type reference (TYPE)	VBC_APP_ID		Application ID	20100527
2	Returning	RO_APP	Value transfer	☐	Object reference (TYPE REF TO)	IF_VBC_APP		Main Visual Business Application Interface	20100527

Method GET_NULL_OBJECT on class CL_VBC_APPLICATION_FACTORY has no exception.

Method PARSE_APP_STRUCTURE_XML Signature

Method PARSE_APP_STRUCTURE_XML on class CL_VBC_APPLICATION_FACTORY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_VBC_LATER_VERSION_EXISTS	☐		20100527
2	CX_VBC_MODEL_CREATION	☐		20100527

Method PARSE_CONTAINER_XMLS Signature

Method PARSE_CONTAINER_XMLS on class CL_VBC_APPLICATION_FACTORY has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_VBC_MODEL_CREATION	☐		20100527

Method UPDATE_META_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_APP	Call by reference	☐	Object reference (TYPE REF TO)	IF_VBC_APP			20100527
2	Importing	IO_DOMAIN_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	IF_VBC_DOMAIN_OBJECT		Domain Object Interface	20100527
3	Importing	IS_METADATA	Call by reference	☐	Type reference (TYPE)	VBC_S_APP_METADATA		Model Metadata	20100527

Method UPDATE_META_DATA on class CL_VBC_APPLICATION_FACTORY has no exception.

History

Last changed by/on	SAP	20110908
SAP Release Created in	703