SAP ABAP Class CL_CFX_S_API_HLP (Helper class for single API)

Hierarchy

☛ CPRXRPM (Software Component) SAP Portfolio and Project Management 6.0
   ⤷ PLM-CFO (Application Component) Collaboration Folders
     ⤷ CFX_API (Package) Collaboration Folders: API

Properties

Class	CL_CFX_S_API_HLP
Short Description	Helper class for single API
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CFX_API	Collaboration Folders: API
Created	20060821	SAP
Last change	20141109
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)
2	CFXA0	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
3	CFXF1	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CL_CFX_S_API_HLP has no interface implemented.

Friends

Class CL_CFX_S_API_HLP has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	SC_LINK_DOC_CL_TYP	Constant	Public	☐	Type reference (TYPE)	CFX_API_T_STRING	'Documents'	Attribute name used to represent linked docs in classic obj	20060823
2	SC_LINK_MPN_CL_TYP	Constant	Public	☐	Type reference (TYPE)	CFX_API_T_STRING	'MPNS'	Attribute name used to represent linked mpns in classic obj	20060823
3	SC_READ_DONE	Constant	Public	☐	Type reference (TYPE)	CFX_S_API_STATUS	'002'	single api status of each object	20060821
4	SC_READ_HEADER	Constant	Public	☐	Type reference (TYPE)	CFX_S_API_STATUS	'001'	single api status of each object	20060821
5	SC_WRITE_CHANGE_OBJ	Constant	Public	☐	Type reference (TYPE)	CFX_S_API_STATUS	'002'	single api status of each object	20060821
6	SC_WRITE_DONE	Constant	Public	☐	Type reference (TYPE)	CFX_S_API_STATUS	'003'	single api status of each object	20060821
7	SC_WRITE_NEW_OBJ	Constant	Public	☐	Type reference (TYPE)	CFX_S_API_STATUS	'001'	single api status of each object	20060821
8	ST_GEN_FIELDS	Static Attribute	Public	☐	Type reference (TYPE)	CFX_S_API_TT_GEN_FIELDS		table of generic object fields and their type reference	20060821

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ASSERT_IS_INITIAL	Static method	Public	Method	raise fatal error if initial	20061006
2	DO_S_API_BOM_READ	Static method	Private	Method	Single API method to read the bom	20061128
3	DO_S_API_BOM_WRITE	Static method	Private	Method	Single API method to write the bom	20061010
4	DO_S_API_DOCUMENT_READ	Static method	Private	Method	Single API method to read the document	20061128
5	DO_S_API_DOCUMENT_WRITE	Static method	Private	Method	Single API method to write the document	20061010
6	DO_S_API_DOC_HEADER	Static method	Private	Method	Single API method to write the Doc Header	20061128
7	DO_S_API_GENERIC_READ	Static method	Private	Method	Single API method to read the generic	20061128
8	DO_S_API_GENERIC_WRITE	Static method	Private	Method	Single API method to write the generic	20061010
9	DO_S_API_MATERIAL_READ	Static method	Private	Method	Single API method to read the material	20061128
10	DO_S_API_MATERIAL_WRITE	Static method	Private	Method	Single API method to write the material	20061010
11	DO_S_API_READ	Static method	Public	Method	Single API method to read the objects	20061128
12	DO_S_API_WRITE	Static method	Public	Method	Single API method to write the objects	20061010
13	GET_BACKEND_NAME	Static method	Public	Method	Get existing or new backend name of the ID	20060821
14	GET_DEF_SEQUENCE_OF_EXECUTION	Static method	Public	Method	Get the default sequence of execution	20060821
15	GET_GENERIC_OBJ_FIELDS	Static method	Public	Method	Get the list of generic object fields	20060821
16	INTIALIZE_IDS_TABLE_READ	Static method	Public	Method	Initialize the IDS table used in the Single API during READ	20060821
17	INTIALIZE_IDS_TABLE_WRITE	Static method	Public	Method	Initialize the IDS table used in the Single API during WRITE	20060821
18	SET_SEQUENCE_IDS	Static method	Public	Method	Set the sequence of execution	20060821
19	UPD_TAB_EXISTING_IDS	Static method	Public	Method	Upd tab doc ids if exist in the folder using alias	20061006

Events

Class CL_CFX_S_API_HLP has no event.

Types

Class CL_CFX_S_API_HLP has no local type.

Method Signatures

Method ASSERT_IS_INITIAL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJ	Call by reference	☐	Type reference (TYPE)	DATA			20061006

Method ASSERT_IS_INITIAL on class CL_CFX_S_API_HLP has no exception.

Method DO_S_API_BOM_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_BOM	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_BOM_READ		Single API BOM table.	20061128
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061128

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_BOM_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_BOM	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_BOM		Single API BOM table.	20061010
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061010

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_DOCUMENT_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DOCUMENT	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_DOCUMENT		Single API document table	20061128
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061128

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_DOCUMENT_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_DOCUMENT	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_DOCUMENT		Single API document table	20061010
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061010

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_DOC_HEADER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061128
2	Changing	C_DOC_ID	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in character form	20061128
3	Importing	IS_HEADER	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TS_DOC_HEADER		Single API Document Header Structure	20061128
4	Importing	I_BACKEND_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20061128
5	Importing	I_BACKEND_SYSTEM	Call by reference	☐	Type reference (TYPE)	STRING			20061128

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_GENERIC_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_GENERIC	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_GENERIC		Single API Generic Object table	20061128
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061128

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_GENERIC_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_GENERIC	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_GENERIC		Single API Generic Object table	20061010
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061010

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_MATERIAL_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061128
2	Changing	CT_MATERIAL	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_MAT_READ		Single API Material table	20061128

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_MATERIAL_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061010
2	Changing	CT_MATERIAL	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_MAT		Single API Material table	20061010

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method DO_S_API_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_BOM	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_BOM_READ		Single API BOM table.	20061128
2	Changing	CT_DOCUMENT	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_DOCUMENT		Single API document table	20061128
3	Changing	CT_GENERIC	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_GENERIC		Single API Generic Object table	20061128
4	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061128
5	Changing	CT_MATERIAL	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_MAT_READ		Single API Material table	20061128
6	Exporting	ET_FAULT	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_FAULT		Table that has all the fault during the single api call.	20061128
7	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	CFX_API_T_BOOL		Boolean Type	20061128
8	Importing	I_EXPLOSION_LEVEL	Call by reference	☐	Type reference (TYPE)	I		explosion level	20061128

Method DO_S_API_READ on class CL_CFX_S_API_HLP has no exception.

Method DO_S_API_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_BOM	Call by reference	☑	Type reference (TYPE)	CFX_S_API_TT_BOM		Single API BOM table.	20061010
2	Changing	CT_DOCUMENT	Call by reference	☑	Type reference (TYPE)	CFX_S_API_TT_DOCUMENT		Single API document table	20061010
3	Changing	CT_GENERIC	Call by reference	☑	Type reference (TYPE)	CFX_S_API_TT_GENERIC		Single API Generic Object table	20061010
4	Changing	CT_IDS	Call by reference	☑	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20061010
5	Changing	CT_MATERIAL	Call by reference	☑	Type reference (TYPE)	CFX_S_API_TT_MAT		Single API Material table	20061010
6	Exporting	ET_FAULT	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_FAULT		Table that has all the fault during the single api call.	20061010
7	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	CFX_API_T_BOOL		Boolean Type	20061010

Method DO_S_API_WRITE on class CL_CFX_S_API_HLP has no exception.

Method GET_BACKEND_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CS_ID	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TS_IDS		Single API: GUID ids and the Name of cFolders Obj	20060821
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20060821

Method GET_BACKEND_NAME on class CL_CFX_S_API_HLP has no exception.

Method GET_DEF_SEQUENCE_OF_EXECUTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SEQUENCE	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_SEQUENCE		single api sequence of exec table	20060821

Method GET_DEF_SEQUENCE_OF_EXECUTION on class CL_CFX_S_API_HLP has no exception.

Method GET_GENERIC_OBJ_FIELDS Signature

Method GET_GENERIC_OBJ_FIELDS on class CL_CFX_S_API_HLP has no parameter.
Method GET_GENERIC_OBJ_FIELDS on class CL_CFX_S_API_HLP has no exception.

Method INTIALIZE_IDS_TABLE_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_GENERAL	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20060821
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20060821
3	Exporting	ET_FAULT	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_FAULT		Table that has all the fault during the single api call.	20060821
4	Exporting	E_ERROR	Call by reference	☐	Type reference (TYPE)	CFX_BOOLEAN		Boolean Type	20060821

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method INTIALIZE_IDS_TABLE_WRITE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_GENERAL	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20060821
2	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20060821

#	Exception	Resumable	Description	Created on
1	CX_CFX_S_API_CHECKS	☐	Single API Checks	20061129

Method SET_SEQUENCE_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_IDS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_TT_IDS		Single API: Table of GUIDs and name	20060821
2	Importing	I_SEQUENCE_STATUS	Call by reference	☐	Type reference (TYPE)	CFX_S_API_STATUS		single api status of each object	20060821
3	Importing	I_TYPE_ID	Call by reference	☐	Type reference (TYPE)	CFX_T_EXTERNAL_ID		External ID	20060821
4	Importing	I_TYPE_NAMESPACE	Call by reference	☐	Type reference (TYPE)	CFX_T_EXTERNAL_NAMESPACE		External Namespace	20060823

Method SET_SEQUENCE_IDS on class CL_CFX_S_API_HLP has no exception.

Method UPD_TAB_EXISTING_IDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_GENERAL	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20061006

Method UPD_TAB_EXISTING_IDS on class CL_CFX_S_API_HLP has no exception.

History

Last changed by/on	SAP	20141109
SAP Release Created in	450