SAP ABAP Class CL_CFX_BI_BADI_OBJECT (Folder Object for BAdI)

Hierarchy

☛ SAP_APPL (Software Component) Logistics and Accounting
   ⤷ CA (Application Component) Cross-Application Components
     ⤷ CFX_BI_BOM (Package) cFolders Backend Integration, BOMs

Properties

Class	CL_CFX_BI_BADI_OBJECT
Short Description	Folder Object for BAdI
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	CFX_BI_BOM	cFolders Backend Integration, BOMs
Created	20050125	SAP
Last change	20100310	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CFX_BI_BADI_OBJECT has no interface implemented.

Friends

Class CL_CFX_BI_BADI_OBJECT has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MP_FOLDER_OBJECT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER_OBJECT		Folder Object for cFolders Back-End Integration	20050125

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_MESSAGE	Instance method	Public	Method	Adds Message to Object Log	20050427
2	CHECK_EXPORTED_BOM	Instance method	Public	Method	Check Exported BOM	20090216
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20050126
4	GET_BACKEND_KEY_TABLE	Instance method	Public	Method	Delivers Back-End Keys of Object	20050125
5	GET_BASE_AND_PATH	Instance method	Public	Method	Delivers Base Folder ID and Folder Path	20050407
6	GET_BASE_AND_PATH_TAB	Instance method	Public	Method	Get Base and Path As Table	20090317
7	GET_CFOLDERS_ID	Instance method	Public	Method	Delivers cFolders GUID of Object (if Available)	20050407
8	GET_CFOLDERS_OBJECT_NAME	Instance method	Public	Method	Delivers Name of Object in cFolders	20050407
9	GET_ID_NAMESPACE	Instance method	Public	Method	Returns cFolders ID and Namespace of Object Type	20050407
10	GET_ID_ROOT_FOLDER	Instance method	Public	Method	Get ID for Root Folder of Collaboration	20090709
11	GET_IS_READ_ONLY	Instance method	Public	Method	Returns Whether Object Is Write-Protected in cFolders	20050407
12	GET_ITEM_CMP_BOM_TYPE	Instance method	Public	Method	Get Component Item Subassembly Type	20090522
13	GET_ROOT_FOLDER_ID	Instance method	Public	Method	Get Root Folder ID	20090406
14	GET_RUN_CONTEXT	Instance method	Public	Method	Running Context, Default Value Is SPACE	20090304
15	GET_TRANSPORT_STATUS	Instance method	Public	Method	Returns Transport Status	20050427
16	SET_BASE_AND_PATH	Instance method	Public	Method	Sets the Base Folder ID and the Path of the Folder	20050126
17	SET_BASE_AND_PATH_TAB	Instance method	Public	Method	Set Base and Path with Path Input As Table	20090317
18	SET_CFOLDERS_OBJECT_NAME	Instance method	Public	Method	Sets the Name of the Object in cFolders	20050126
19	SET_IS_READ_ONLY	Instance method	Public	Method	Object in cFolders Is Write-Protected	20050126
20	SET_TRANSPORT_STATUS_ERROR	Instance method	Public	Method	Sets Transport Status to Error	20050427

Events

Class CL_CFX_BI_BADI_OBJECT has no event.

Types

Class CL_CFX_BI_BADI_OBJECT has no local type.

Method Signatures

Method ADD_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSG_ID	Call by reference	☐	Type reference (TYPE)	SYMSGID		Nachrichtenklasse	20050427
2	Importing	I_MSG_NO	Call by reference	☐	Type reference (TYPE)	SYMSGNO		Nachrichtennummer	20050427
3	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY		Nachrichtentyp	20050427
4	Importing	I_MSG_V1	Call by reference	☑	Type reference (TYPE)	C		Nachrichtenvariable	20050427
5	Importing	I_MSG_V2	Call by reference	☑	Type reference (TYPE)	C		Nachrichtenvariable	20050427
6	Importing	I_MSG_V3	Call by reference	☑	Type reference (TYPE)	C		Nachrichtenvariable	20050427
7	Importing	I_MSG_V4	Call by reference	☑	Type reference (TYPE)	C		Nachrichtenvariable	20050502

Method ADD_MESSAGE on class CL_CFX_BI_BADI_OBJECT has no exception.

Method CHECK_EXPORTED_BOM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_EXPORTED_BOM	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20090216

Method CHECK_EXPORTED_BOM on class CL_CFX_BI_BADI_OBJECT has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_FOLDER_OBJECT	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER_OBJECT		Mappenobjekt für cFolders Backendintegration	20050126

Method CONSTRUCTOR on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_BACKEND_KEY_TABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BACKEND_KEY	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_NAME_VALUE		Tabelle mit Name und Wert	20050125

Method GET_BACKEND_KEY_TABLE on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_BASE_AND_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_BASE_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		cFolders GUID des Base Folders	20050407
2	Exporting	E_PATH	Call by reference	☐	Type reference (TYPE)	STRING		zusätzlicherPfad unter dem Base Folder	20050407

Method GET_BASE_AND_PATH on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_BASE_AND_PATH_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_BASE_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090317
2	Exporting	E_PATH_TAB	Call by reference	☐	Type reference (TYPE)	CFX_BI_API_TT_STRING		Tabelle der API-Zeichenketten	20090317

Method GET_BASE_AND_PATH_TAB on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_CFOLDERS_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_CFX_ID	Value transfer	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20050407

Method GET_CFOLDERS_ID on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_CFOLDERS_OBJECT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_NAME	Value transfer	☐	Type reference (TYPE)	CFX_BI_T_DOC_NAME		Name des cFolders-Dokuments	20050407

Method GET_CFOLDERS_OBJECT_NAME on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_ID_NAMESPACE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ID	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_EXTERNAL_ID			20050407
2	Exporting	E_NAMESPACE	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_EXTERNAL_NAMESPACE		Externer Namensraum	20050407

Method GET_ID_NAMESPACE on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_ID_ROOT_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ROOT_FOLDER_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090709

Method GET_ID_ROOT_FOLDER on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_IS_READ_ONLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_IS_READ_ONLY	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050407

Method GET_IS_READ_ONLY on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_ITEM_CMP_BOM_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_BOM_ITEM_TYPE	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_BOM_ITEM_CMP_TYPE			20090522

Method GET_ITEM_CMP_BOM_TYPE on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_ROOT_FOLDER_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_BASE_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		Funktionscode, der PAI ausgelöst hat	20090406
2	Exporting	E_PATH_TAB	Call by reference	☐	Type reference (TYPE)	CFX_BI_API_TT_STRING		UUID in Character-Darstellung	20090406

Method GET_ROOT_FOLDER_ID on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_RUN_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	E_RUN_CONTEXT	Value transfer	☐	Type reference (TYPE)	STRING			20090304

Method GET_RUN_CONTEXT on class CL_CFX_BI_BADI_OBJECT has no exception.

Method GET_TRANSPORT_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_TRANSPORT_STATUS	Value transfer	☐	Type reference (TYPE)	CFX_BI_T_TRANSPORT_STATUS		Transportstatus von/nach cFolders System	20050427

Method GET_TRANSPORT_STATUS on class CL_CFX_BI_BADI_OBJECT has no exception.

Method SET_BASE_AND_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_BASE_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		cFolders GUID des Base Folders	20050126
2	Changing	C_PATH	Call by reference	☐	Type reference (TYPE)	STRING		zusätzlicherPfad unter dem Base Folder	20050126

#	Exception	Resumable	Description	Created on
1	BASE_INVALID	☐	Angegebene Base folder ID ist ungültig	20050126
2	FOLDER_CHANGE_FORBIDDEN	☐	Zielmappe darf nicht geändert werden	20050427
3	PATH_INVALID	☐	Angegebner Pfad ist ungültig	20050126
4	WRONG_AREA	☐	Mappe liegt in nicht auswählbarer Area	20050426

Method SET_BASE_AND_PATH_TAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_BASE_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090317
2	Changing	C_PATH_TAB	Call by reference	☐	Type reference (TYPE)	CFX_BI_API_TT_STRING		Tabelle der API-Zeichenketten	20090317

#	Exception	Resumable	Description	Created on
1	BASE_INVALID	☐	Angegebene Base folder ID ist ungültig	20090317
2	FOLDER_CHANGE_FORBIDDEN	☐	Zielmappe darf nicht geändert werden	20090317
3	PATH_INVALID	☐	Angegebner Pfad ist ungültig	20090317
4	WRONG_AREA	☐	Mappe liegt in nicht auswählbarer Area	20090317

Method SET_CFOLDERS_OBJECT_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_DOC_NAME		Name des cFolders-Dokuments	20050126

#	Exception	Resumable	Description	Created on
1	NAME_CHANGE_FORBIDDEN	☐	Änderung des Namens nicht erlaubt	20050427

Method SET_IS_READ_ONLY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_IS_READONLY	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20050126

#	Exception	Resumable	Description	Created on
1	SET_READ_ONLY_FORBIDDEN	☐	Read only Flag darf nicht geändert werden	20050427

Method SET_TRANSPORT_STATUS_ERROR Signature

Method SET_TRANSPORT_STATUS_ERROR on class CL_CFX_BI_BADI_OBJECT has no parameter.

#	Exception	Resumable	Description	Created on
1	STATUS_CHANGE_FORBIDDEN	☐	Objekt wurde bereits transportiert	20050427

History

Last changed by/on	SAP	20100310
SAP Release Created in	600