SAP ABAP Class CL_CFX_BI_FOLDER (cFolders Folder for cFolders Backend Integration)

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_FOLDER
Short Description	cFolders Folder for cFolders Backend Integration
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	20020523	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_FOLDER has no interface implemented.

Friends

Class CL_CFX_BI_FOLDER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	KT_FOLDER	Static Attribute	Private	☐	Type reference (TYPE)	CFX_BI_TT_FOLDER		Table of cFolders Folders	20020906
2	MP_CFOLDERS_SYSTEM	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System for cFolders Backend Integration	20020523
3	MP_OBJECT_CATEGORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CFX_BI_OBJECT_CATEGORY		Object Category in cFolders System	20050304
4	MP_PARENT_FOLDER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Folder for cFolders Back-End Integration	20050125
5	MT_ALIAS_VALUES	Instance attribute	Public	☐	Type reference (TYPE)	CFX_BI_API_TT_ALIAS_VALUE		List of Aliases	20050530
6	MT_CF_DOCUMENT	Instance attribute	Private	☐	Type reference (TYPE)	TT_DOCUMENT_NAME_UPPERCASE		Table of cFolders Documents	20020909
7	MT_FOLDERS	Instance attribute	Private	☐	Type reference (TYPE)	CFX_BI_TT_ID_NAME_STRING		List of Folders	20020523
8	M_ADDITIONAL_PATH	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Additional path (if folder does not exist yet)	20050125
9	M_ADDITIONAL_PATH_TAB	Instance attribute	Private	☐	Type reference (TYPE)	CFX_BI_API_TT_STRING		API Character String Table	20090317
10	M_AREA_ID	Instance attribute	Private	☐	Type reference (TYPE)	SYSUUID_C		GUID in 'CHAR' Format in Upper Case	20020523
11	M_AREA_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of Area in cFolders System	20020523
12	M_BASE_FOLDER_ID	Instance attribute	Private	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character Format	20050125
13	M_COLLABORATION_ID	Instance attribute	Private	☐	Type reference (TYPE)	SYSUUID_C		GUID in 'CHAR' Format in Upper Case	20020523
14	M_COLLABORATION_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of Collaboration in cFolders System	20020523
15	M_ID	Instance attribute	Public	☑	Type reference (TYPE)	SYSUUID_C		GUID in 'CHAR' Format in Upper Case	20020523
16	M_IS_IN_STANDARD_AREA	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Is Folder in Standards Scenario?	20050125
17	M_MT_CF_DOCUMENT_VALID	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Valid Cache?	20020909
18	M_NAME	Instance attribute	Private	☐	Type reference (TYPE)	STRING		Name of BOM in cFolders System	20020523
19	M_SCENARIO	Instance attribute	Private	☐	Type reference (TYPE)	STRING		cFolders: Scenario (Collaboration or Competition)	20020523
20	SC_BACKEND_SYSTEM_IPPE_SAP	Constant	Public	☐	Type reference (TYPE)	CFX_BI_BS_NAME	'SAP'	Constants in Back-End System for iPPE Aliases	20050530
21	SC_IPPE_CONTEXT_YES	Constant	Public	☐	Type reference (TYPE)	STRING	'yes'		20050530
22	SC_IPPE_SUBORDINARY_FOLDER	Constant	Public	☐	Type reference (TYPE)	STRING	'Subordinary folder of iPPE-Extract'	Character String for Collaboration Folders	20050530
23	SC_IPPE_SUPERIOR_FOLDER	Constant	Public	☐	Type reference (TYPE)	STRING	'Superior folder of iPPE-Extract'	Character String for Collaboration Folders	20050530
24	SC_SLASH	Constant	Private	☐	Type reference (TYPE)	STRING	'/'	Slash	20050125
25	SC_SUB_FOL_WITH_IPPE_OBJECTS	Constant	Public	☐	Type reference (TYPE)	STRING	'Subordinary folder with iPPE-Objects'	Character String for Collaboration Folders	20050530
26	SV_SUBST_SLASH	Static Attribute	Public	☐	Type reference (TYPE)	STRING		Substitute for Slash; if Folder Name Requires Slash Use This	20090316

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_OBJECT_CATEGORY	Instance method	Public	Method	Tries to Add an Object Category to Folder	20050401
2	ASSIGN_CATEGORY	Instance method	Public	Method	Exports the Folder Category to cFolders	20050422
3	AUX_SELECT_BY_USER	Static method	Private	Method	User Chooses Folder Object for Which Has Read Authorization	20020906
4	AUX_SET_OBJECT_CATEGORY	Instance method	Private	Method	Adds an Object Category to Folder	20050401
5	CHECK_PATH	Static method	Private	Method	Checks whether path is valid	20050126
6	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20090316
7	CONSTRUCTOR	Instance method	Public	Constructor	.	20020523
8	COPY	Instance method	Private	Method	Create Copy of Folder	20020611
9	CREATE_IN_CFX	Instance method	Private	Method	Creates New Folders in CFX	20050405
10	EXPORT_CATEGORY	Instance method	Public	Method	Exports the Folder Category to cFolders	20050315
11	EXPORT_FOLDERS	Static method	Public	Method	Exports Folders	20050405
12	GET_ALIASES	Instance method	Public	Method	Delivers Aliases of Object	20050530
13	GET_AREA_ID	Instance method	Public	Method	ID of Work Area	20020819
14	GET_AS_STRING	Instance method	Public	Method	Coll., Area, Depict as String	20020523
15	GET_BASE_AND_PATH	Instance method	Public	Method	Returns Base ID and Path	20050126
16	GET_BASE_AND_PATH_TAB	Instance method	Public	Method	Get Base and Path From Internal Table	20090317
17	GET_CHILDREN_OF_PARENTS	Static method	Private	Method	Delivers the Child Folders of the Parent Folders	20050126
18	GET_DOC_FOR_NAME	Instance method	Public	Method	Determine Document in this Folder by Specified Name	20020909
19	GET_DOC_LIST	Instance method	Private	Method	Determine Documents in This Folder	20020909
20	GET_FOLDERS_AS_STRING	Instance method	Public	Method	Folders as String	20020523
21	GET_FOLDERS_OF_AREA	Static method	Private	Method	Delivers all folders from area that are in kt_folder	20050125
22	GET_FOLDER_PATH_AS_STRING	Instance method	Private	Method	Folder path as string if not in cFolders yet	20050125
23	GET_FOR_BASE_AND_PATH	Static method	Public	Method	Delivers Folder for Base ID and Path	20050125
24	GET_FOR_BASE_PATH_ITAB	Static method	Public	Method	Get Folder for Base ID and Path by Passing itab	20090317
25	GET_FOR_ID	Static method	Public	Method	Determine Object for ID	20020906
26	GET_ID	Instance method	Public	Method	Folder ID	20020523
27	GET_NAME	Instance method	Public	Method	Folder name	20020523
28	GET_NEW_CF_DOC_NAME	Instance method	Public	Method	Determine Name for the New Document in This Folder	20020909
29	GET_OBJECT_ALV	Instance method	Public	Method	Prepare Data for ALV	20020524
30	GET_OBJECT_CATEGORY	Instance method	Public	Method	Delivers Object Category of Folder (if Available)	20050401
31	GET_PARENT_FOLDER	Instance method	Public	Method	Delivers Superior Folder	20050125
32	GET_ROOT_FOLDER_ID	Instance method	Public	Method	Get Root Folder ID	20090709
33	GET_SCENARIO	Instance method	Public	Method	Returns Scenario That Contains Folder	20050426
34	INITIALIZE_FROM_ID	Instance method	Private	Method	Set All Data from cFolders ID	20020613
35	IS_CHILD_OF	Instance method	Public	Method	Is this folder a(n) (in)direct child of the transferred Fldr	20050407
36	IS_FOLDER_ALLOWED	Instance method	Public	Method	Is export in this folder allowed?	20050530
37	PREPARE_FOR_EXPORT	Static method	Public	Method	Prepares Export	20050125
38	READ_ALIASES	Instance method	Public	Method	Delivers Aliases of Folder	20050530
39	REFRESH_CFX	Static method	Public	Method	Read cFolders Data Again	20020909
40	RESET_ALL_FOLDERS	Static method	Public	Method	Deletes All Folders	20050426
41	RETRIEVE_CFX_FOLDER_ID	Instance method	Private	Method	Retrieve Folder ID	20090317
42	RETRIEVE_CFX_ID	Instance method	Private	Method	Finds cFolders GUID for Base ID and Path	20050406
43	SEARCH_FOLDER_NAME	Instance method	Private	Method	Search for Name in Collaboration up to Given Level	20090317
44	SELECT_BY_USER	Static method	Public	Method	Users Choose Folder for Which They have Write Authorization	20020523
45	SELECT_DOCUMENT_BY_USER	Static method	Public	Method	User Chooses Folder Object for Which Has Read Authorization	20020607
46	SORT_FOR_EXPORT	Static method	Private	Method	Sorts Table of Required Folders	20050125
47	UPDATE_ROOT	Static method	Public	Method	Update Root Folder (for Col Create)	20050407

Events

Class CL_CFX_BI_FOLDER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_DOCUMENT_NAME_UPPERCASE	Private	See coding		TS_DOCUMENT_NAME_UPPERCASE	20020909	BEGIN OF ts_document_name_uppercase, doc TYPE cfx_bi_ts_cf_document, name_uc TYPE cfx_bi_t_doc_name, END OF ts_document_name_uppercase
2	TT_DOCUMENT_NAME_UPPERCASE	Private	See coding		TT_DOCUMENT_NAME_UPPERCASE	20020909	tt_document_name_uppercase TYPE SORTED TABLE OF ts_document_name_uppercase WITH NON-UNIQUE KEY name_uc

Method Signatures

Method ADD_OBJECT_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20050401
2	Importing	IP_OBJECT_CATEGORY	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_OBJECT_CATEGORY		Objekt Category im cFolders System	20050401
3	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20050401

Method ADD_OBJECT_CATEGORY on class CL_CFX_BI_FOLDER has no exception.

Method ASSIGN_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CANCEL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Vom Anwender abgebrochen	20050422
2	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler aufgetreten	20050422
3	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichtentyp	20050422

Method ASSIGN_CATEGORY on class CL_CFX_BI_FOLDER has no exception.

Method AUX_SELECT_BY_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_DOC_ID	Call by reference	☑	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20020906
2	Changing	C_DOC_NAME	Call by reference	☑	Type reference (TYPE)	CFX_BI_T_DOC_NAME		Name des cFolders Dokumentes	20020906
3	Exporting	EP_SELECTED_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020906
4	Exporting	E_AREA_HAS_CHANGED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		cFolders area hat sich geändert	20020906
5	Exporting	E_CANCEL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Anwender hat abgebrochen	20020906
6	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020906
7	Exporting	E_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	CFX_BI_API_T_OBJECT_TYPE		Objekt Typ	20020906
8	Exporting	E_TYPE_ID	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_EXTERNAL_ID			20050317
9	Exporting	E_TYPE_NAMESPACE	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_EXTERNAL_NAMESPACE			20050317
10	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20020906
11	Importing	IP_DEFAULT_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020906
12	Importing	IT_OBJECT_TYPES	Call by reference	☑	Type reference (TYPE)	CFX_BI_API_TT_ID_NS			20020906
13	Importing	I_FIX_AREA	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Area darf nicht geändert werden	20020906
14	Importing	I_MSG_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020906
15	Importing	I_SELECT_DOCUMENT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Dokument wählen ?	20020906

Method AUX_SELECT_BY_USER on class CL_CFX_BI_FOLDER has no exception.

Method AUX_SET_OBJECT_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_OBJECT_CATEGORY	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_OBJECT_CATEGORY		Objekt Category im cFolders System	20050401

Method AUX_SET_OBJECT_CATEGORY on class CL_CFX_BI_FOLDER has no exception.

Method CHECK_PATH Signature

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

#	Exception	Resumable	Description	Created on
1	PATH_INVALID	☐	Pfad ist ungültig	20050126

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class CL_CFX_BI_FOLDER has no parameter.
Method CLASS_CONSTRUCTOR on class CL_CFX_BI_FOLDER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20020523

Method CONSTRUCTOR on class CL_CFX_BI_FOLDER has no exception.

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_FOLDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020611

Method COPY on class CL_CFX_BI_FOLDER has no exception.

Method CREATE_IN_CFX Signature

Method CREATE_IN_CFX on class CL_CFX_BI_FOLDER has no parameter.
Method CREATE_IN_CFX on class CL_CFX_BI_FOLDER has no exception.

Method EXPORT_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_CANCEL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Vom Anwender abgebrochen	20050315
2	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler aufgetreten	20050315
3	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichtentyp	20050315

Method EXPORT_CATEGORY on class CL_CFX_BI_FOLDER has no exception.

Method EXPORT_FOLDERS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20050407

Method EXPORT_FOLDERS on class CL_CFX_BI_FOLDER has no exception.

Method GET_ALIASES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_ALIAS_VALUES	Call by reference	☐	Attribute reference (LIKE)	MT_ALIAS_VALUES		Lister der Aliase	20050530

Method GET_ALIASES on class CL_CFX_BI_FOLDER has no exception.

Method GET_AREA_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_AREA_ID	Value transfer	☐	Type reference (TYPE)	SYSUUID_C		ID	20020819

Method GET_AREA_ID on class CL_CFX_BI_FOLDER has no exception.

Method GET_AS_STRING Signature

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

Method GET_AS_STRING on class CL_CFX_BI_FOLDER 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		UUID in Character-Darstellung	20050126
2	Exporting	E_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20050126

Method GET_BASE_AND_PATH on class CL_CFX_BI_FOLDER 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_FOLDER has no exception.

Method GET_CHILDREN_OF_PARENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_FOLDER	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_FOLDER		Tabelle von cFolders Foldern	20050126
2	Exporting	ET_CHILD_FOLDER	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_FOLDER		Tabelle von cFolders Foldern	20050126
3	Importing	IT_PARENT_FOLDER	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_FOLDER		Tabelle von cFolders Foldern	20050126

Method GET_CHILDREN_OF_PARENTS on class CL_CFX_BI_FOLDER has no exception.

Method GET_DOC_FOR_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_CF_DOCUMENT	Call by reference	☐	Type reference (TYPE)	CFX_BI_TS_CF_DOCUMENT		cFolders-Dokument	20020909
2	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020909
3	Exporting	E_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		gefunden ?	20020909
4	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020909
5	Importing	I_NAME	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_DOC_NAME		Name des cFolder-Dokuments	20020909

#	Exception	Resumable	Description	Created on
1	CFOLDERS_API_ERROR	☐	Fehlermeldung der cFolders API	20020909

Method GET_DOC_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020909
2	Importing	I_MSG_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020909

#	Exception	Resumable	Description	Created on
1	CFOLDERS_API_ERROR	☐	Fehlermeldung der cFolders API	20020909

Method GET_FOLDERS_AS_STRING Signature

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

Method GET_FOLDERS_AS_STRING on class CL_CFX_BI_FOLDER has no exception.

Method GET_FOLDERS_OF_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_FOLDER	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_FOLDER		Tabelle von cFolders Foldern	20050125
2	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20050407
3	Importing	I_AREA_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20050125

Method GET_FOLDERS_OF_AREA on class CL_CFX_BI_FOLDER has no exception.

Method GET_FOLDER_PATH_AS_STRING Signature

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

Method GET_FOLDER_PATH_AS_STRING on class CL_CFX_BI_FOLDER has no exception.

Method GET_FOR_BASE_AND_PATH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20050125
2	Importing	I_BASE_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20050125
3	Importing	I_PATH	Call by reference	☐	Type reference (TYPE)	STRING			20050125
4	Returning	RP_FOLDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20050125

#	Exception	Resumable	Description	Created on
1	BASE_INVALID	☐	Base ID existiert nicht	20050126
2	PATH_INVALID	☐	Pfad ist ungültig	20050126

Method GET_FOR_BASE_PATH_ITAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☑	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20090317
2	Importing	I_BASE_ID	Call by reference	☑	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090317
3	Importing	I_PATH_TAB	Call by reference	☑	Type reference (TYPE)	CFX_BI_API_TT_STRING		Tabelle der API-Zeichenketten	20090317
4	Returning	RP_FOLDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20090317

#	Exception	Resumable	Description	Created on
1	BASE_INVALID	☐	Base ID existiert nicht	20090317
2	PATH_INVALID	☐	Pfad ist ungültig	20090317

Method GET_FOR_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020906
2	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020906
3	Exporting	E_EXIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Mappe (mit dieser ID) gibt es in cFolders ?	20020906
4	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20020906
5	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20020906
6	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020906

Method GET_FOR_ID on class CL_CFX_BI_FOLDER has no exception.

Method GET_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_ID	Value transfer	☐	Type reference (TYPE)	SYSUUID_C		ID	20020523

Method GET_ID on class CL_CFX_BI_FOLDER has no exception.

Method GET_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)	STRING		Name	20020523

Method GET_NAME on class CL_CFX_BI_FOLDER has no exception.

Method GET_NEW_CF_DOC_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020909
2	Exporting	E_NAME	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_DOC_NAME		Neuer (noch nicht verwendeter) Name des cFolder-Dokuments	20020909
3	Importing	I_BASE_NAME	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_DOC_NAME		Name des cFolder-Dokuments	20020909
4	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020909

#	Exception	Resumable	Description	Created on
1	CFOLDERS_API_ERROR	☐	Fehlermeldung der cFolders API	20020909

Method GET_OBJECT_ALV Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_OBJECT_ALV	Call by reference	☐	Type reference (TYPE)	CFX_BI_TS_FOLDER_OBJECT_ALV		ALV	20020524

Method GET_OBJECT_ALV on class CL_CFX_BI_FOLDER has no exception.

Method GET_OBJECT_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_OBJECT_CATEGORY	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_BI_OBJECT_CATEGORY		Objekt Category im cFolders System	20050401

Method GET_OBJECT_CATEGORY on class CL_CFX_BI_FOLDER has no exception.

Method GET_PARENT_FOLDER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RP_PARENT_FOLDER	Value transfer	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20050125

Method GET_PARENT_FOLDER on class CL_CFX_BI_FOLDER 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	ROOT_FOLDER_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090709

Method GET_ROOT_FOLDER_ID on class CL_CFX_BI_FOLDER has no exception.

Method GET_SCENARIO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_SCENARIO	Value transfer	☐	Type reference (TYPE)	CFX_BI_T_SCENARIO		cFolders: Szenario (Collaboration oder Competition)	20050426

Method GET_SCENARIO on class CL_CFX_BI_FOLDER has no exception.

Method INITIALIZE_FROM_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020906
2	Exporting	E_EXIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Mappe (mit dieser ID) gibt es in cFolders ?	20020906
3	Importing	I_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20020613
4	Importing	I_MSG_TYPE	Call by reference	☑	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020613

Method INITIALIZE_FROM_ID on class CL_CFX_BI_FOLDER has no exception.

Method IS_CHILD_OF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		Ist diese Mappe eine "Mutter"-Mappe zur aktuellen Mappe?	20050407
2	Returning	R_IS_CHILD	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20050407

Method IS_CHILD_OF on class CL_CFX_BI_FOLDER has no exception.

Method IS_FOLDER_ALLOWED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichtentyp	20050530
2	Returning	R_ALLOWED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Erlaubt?	20050530

Method IS_FOLDER_ALLOWED on class CL_CFX_BI_FOLDER has no exception.

Method PREPARE_FOR_EXPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20050407

Method PREPARE_FOR_EXPORT on class CL_CFX_BI_FOLDER has no exception.

Method READ_ALIASES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BACKEND_SYSTEM_NAME	Call by reference	☑	Type reference (TYPE)	CFX_BI_BS_NAME		Backend-Systemname	20050530
2	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichtentyp	20050530
3	Returning	R_ERROR	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Fehler?	20050530

Method READ_ALIASES on class CL_CFX_BI_FOLDER has no exception.

Method REFRESH_CFX Signature

Method REFRESH_CFX on class CL_CFX_BI_FOLDER has no parameter.
Method REFRESH_CFX on class CL_CFX_BI_FOLDER has no exception.

Method RESET_ALL_FOLDERS Signature

Method RESET_ALL_FOLDERS on class CL_CFX_BI_FOLDER has no parameter.
Method RESET_ALL_FOLDERS on class CL_CFX_BI_FOLDER has no exception.

Method RETRIEVE_CFX_FOLDER_ID Signature

Method RETRIEVE_CFX_FOLDER_ID on class CL_CFX_BI_FOLDER has no parameter.

#	Exception	Resumable	Description	Created on
1	CFX_VERSION_INVALID	☐		20090317

Method RETRIEVE_CFX_ID Signature

Method RETRIEVE_CFX_ID on class CL_CFX_BI_FOLDER has no parameter.

#	Exception	Resumable	Description	Created on
1	CFX_VERSION_INVALID	☐		20050602

Method SEARCH_FOLDER_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_PARENT_FOLDER_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090317
2	Returning	R_FOLDER_ID	Value transfer	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20090317

Method SEARCH_FOLDER_NAME on class CL_CFX_BI_FOLDER has no exception.

Method SELECT_BY_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EP_SELECTED_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020906
2	Exporting	E_AREA_HAS_CHANGED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		cFolders area hat sich geändert	20020604
3	Exporting	E_CANCEL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Anwender hat abgebrochen	20020531
4	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020906
5	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20020906
6	Importing	IP_DEFAULT_FOLDER	Call by reference	☑	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020906
7	Importing	I_FIX_AREA	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Area darf nicht geändert werden	20020819
8	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020906

Method SELECT_BY_USER on class CL_CFX_BI_FOLDER has no exception.

Method SELECT_DOCUMENT_BY_USER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_DOC_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in Character-Darstellung	20020607
2	Changing	C_DOC_NAME	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_DOC_NAME		Name des cFolders Dokumentes	20020607
3	Exporting	EP_SELECTED_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020906
4	Exporting	E_AREA_HAS_CHANGED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		cFolders area hat sich geändert	20020607
5	Exporting	E_CANCEL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Anwender hat abgebrochen	20020607
6	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Fehler ?	20020906
7	Exporting	E_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	CFX_BI_API_T_OBJECT_TYPE		Objekt Typ	20020610
8	Exporting	E_TYPE_ID	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_EXTERNAL_ID			20050317
9	Exporting	E_TYPE_NAMESPACE	Call by reference	☐	Type reference (TYPE)	CFX_BI_T_EXTERNAL_NAMESPACE			20050317
10	Importing	IP_CFOLDERS_SYSTEM	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_CFOLDERS_SYSTEM		cFolders System für cFolders Backendintegration	20020906
11	Importing	IP_DEFAULT_FOLDER	Call by reference	☐	Object reference (TYPE REF TO)	CL_CFX_BI_FOLDER		cFolders Mappe für cFolders Backendintegration	20020906
12	Importing	IT_OBJECT_TYPES	Call by reference	☐	Type reference (TYPE)	CFX_BI_API_TT_ID_NS			20020607
13	Importing	I_FIX_AREA	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	Area darf nicht geändert werden	20020819
14	Importing	I_MSG_TYPE	Call by reference	☐	Type reference (TYPE)	SYMSGTY	'I'	Nachrichten, Nachrichtentyp	20020906

Method SELECT_DOCUMENT_BY_USER on class CL_CFX_BI_FOLDER has no exception.

Method SORT_FOR_EXPORT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SORTED_FOLDER	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_FOLDER		Tabelle von cFolders Foldern	20050125
2	Importing	IT_FOLDER	Call by reference	☐	Type reference (TYPE)	CFX_BI_TT_FOLDER		Tabelle von cFolders Foldern	20050125

Method SORT_FOR_EXPORT on class CL_CFX_BI_FOLDER has no exception.

Method UPDATE_ROOT Signature

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

Method UPDATE_ROOT on class CL_CFX_BI_FOLDER has no exception.

History

Last changed by/on	SAP	20100310
SAP Release Created in	2002_1_46C