SAP ABAP Class CB_DOCUMENT_BCS (Base Agent Wrapper Class for Office Documents)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-COM (Application Component) Communication Services: Mail, Fax, SMS, Telephony
     ⤷ SBCOMS (Package) Business Communication Service

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_OS_CA_COMMON	Superclass of the Object Services Class Actors	20001030

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CA_DOCUMENT_BCS	Agent Wrapper Class for Office Documents	20000124

Properties

Class	CB_DOCUMENT_BCS
Short Description	Base Agent Wrapper Class for Office Documents
Super Class	CL_OS_CA_COMMON	Superclass of the Object Services Class Actors
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status	S	System Program
Category	11	Factory for Persistent Class
Package	SBCOMS	Business Communication Service
Created	20000124	SAP
Last change	20000124	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

#	Type group / Object type	Type	Type Description
1	OSCON	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
2	OSTYP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)

Interfaces

Class CB_DOCUMENT_BCS has no interface implemented.

Friends

Class CB_DOCUMENT_BCS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CURRENT_SPECIAL_OBJECT_INFO	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_OBJECT_INFO		Current Class-Specific Object Data	20001030
2	SPECIAL_BKEY_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_BKEY_TAB		Class-Specific: Search Table Business Keys	20001030
3	SPECIAL_OBJECT_INFO	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_OBJECT_INFO_TAB		Class-Specific Object Data	20001030
4	SPECIAL_OID_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_OID_TAB		Class-Specific: Search Table OIDs	20001030

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_PERSISTENT	Instance method	Public	Method	Generate New Persistent Object with Key	20001030
2	CREATE_TRANSIENT	Instance method	Public	Method	Generate Transient Object with Key	20001030
3	DELETE_PERSISTENT	Instance method	Public	Method	Deletes Persistent Object with Key	20001030
4	GET_PERSISTENT	Instance method	Public	Method	Get Persistent Object with Key	20001030
5	GET_TRANSIENT	Instance method	Public	Method	Get Transient Object with Key	20001030
6	MAP_EXTRACT_IDENTIFIER	Instance method	Protected	Method	Extracts BKey and OID from Database Data	20001030
7	MAP_GET_ATTRIBUTES	Instance method	Protected	Method	Reads Persistent Attributes from Object	20001030
8	MAP_LOAD_FROM_DATABASE_GUID	Instance method	Protected	Method	Reads Object Data Identified Using OID from Database	20001030
9	MAP_LOAD_FROM_DATABASE_KEY	Instance method	Protected	Method	Reads Object Data Identified Using Bus. Key from Database	20001030
10	MAP_MERGE_IDENTIFIER	Instance method	Protected	Method	Adds DB Data BKey and OID	20001030
11	MAP_SAVE_TO_DATABASE	Instance method	Protected	Method	Saves Object Data in Database	20001030
12	MAP_SERIALIZE_BKEY	Instance method	Protected	Method	Serializes Business Key	20010125
13	MAP_SET_ATTRIBUTES	Instance method	Protected	Method	Sets Persistent Attributes of an Object	20001030
14	PM_CHECK_AND_SET_ATTRIBUTES	Instance method	Protected	Method	Checks and Sets Persistent Attributes	20001030
15	PM_CREATE_REPRESENTANT	Instance method	Protected	Method	Generate New Wrapper Object and Administration Entry	20001030
16	PM_DELETE_PERSISTENT	Instance method	Protected	Method	Deletes Persistent Object from Database	20001030
17	PM_LOAD_AND_SET_ATTRIBUTES	Instance method	Protected	Method	Loads and Sets Persistent Attributes	20001030

Events

Class CB_DOCUMENT_BCS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_BUSINESS_KEY	Protected	See coding		Business Key	20001030
2	TYP_BUSINESS_KEY_TAB	Protected	See coding	TYP_BUSINESS_KEY	Table Type Object Reference	20001030
3	TYP_DB_DATA	Protected	See coding		Line-Type Persistent Object Data	20001030
4	TYP_DB_DATA_TAB	Protected	See coding	TYP_DB_DATA	Table-Type Persistent Object Data	20001030
5	TYP_DB_DELETE_TAB	Protected	See coding	TYP_SPECIAL_OBJECT_INFO	Table Type Identifiers to Delete	20001030
6	TYP_LPORU	Protected	Type reference (TYPE)	SIBFLPORU	Local Persistent Object Identifier Type	20001030
7	TYP_OBJECT_REF	Protected	Object reference (TYPE REF TO)	CL_DOCUMENT_BCS	Type of Managed Object	20001030
8	TYP_OBJECT_REF_TAB	Protected	See coding	TYP_OBJECT_REF	Table Type Object Reference	20001030
9	TYP_OID	Protected	Type reference (TYPE)	OS_GUID	Type of Generic Object Identifier	20001030
10	TYP_OID_TAB	Protected	See coding	TYP_OID	Table Type Object Identifier	20001030
11	TYP_SPECIAL_BKEY_TAB	Protected	See coding	TYP_SPECIAL_OBJECT_INFO	Table Type Search Table Business Keys	20001030
12	TYP_SPECIAL_OBJECT_INFO	Protected	See coding		Line Type Class-Specific Object Data	20001030
13	TYP_SPECIAL_OBJECT_INFO_TAB	Protected	See coding	TYP_SPECIAL_OBJECT_INFO	Table Type Class-Specific Object Data	20001030
14	TYP_SPECIAL_OID_TAB	Protected	See coding	TYP_SPECIAL_OBJECT_INFO	Table Type Search Table OIDs	20001030
15	TYP_TYPE	Protected	Type reference (TYPE)	OS_GUID	Category of Type Identifier	20010125

Method Signatures

Method CREATE_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCNO	Call by reference	☐	Type reference (TYPE)	SO_OBJ_NO		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_DOCTP	Call by reference	☐	Type reference (TYPE)	SO_OBJ_TP		Betriebswirtschaftlicher Schlüssel	20001030
3	Importing	I_DOCYR	Call by reference	☐	Type reference (TYPE)	SO_OBJ_YR		Betriebswirtschaftlicher Schlüssel	20001030
4	Importing	I_ENCCNT	Call by reference	☑	Type reference (TYPE)	SO_ENC_CNT		Persistentes Attribut	20010125
5	Importing	I_EXTCT	Call by reference	☑	Type reference (TYPE)	SO_EXTCT		Persistentes Attribut	20010125
6	Importing	I_FILE_EXT	Call by reference	☑	Type reference (TYPE)	SO_FILEEXT		Persistentes Attribut	20010125
7	Importing	I_IMPORTANCE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_PRI		Persistentes Attribut	20010125
8	Importing	I_OBJLEN	Call by reference	☑	Type reference (TYPE)	SO_OBJ_LEN		Persistentes Attribut	20010125
9	Importing	I_SENSITIVITY	Call by reference	☑	Type reference (TYPE)	SO_OBJ_SNS		Persistentes Attribut	20010125
10	Importing	I_SUBJECT	Call by reference	☑	Type reference (TYPE)	SO_OBJ_DES		Persistentes Attribut	20010125
11	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_DOCUMENT_BCS		Neu erzeugtes persistentes Objekt	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_EXISTING	☐	Object Services Exception	20010125

Method CREATE_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCNO	Call by reference	☐	Type reference (TYPE)	SO_OBJ_NO		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_DOCTP	Call by reference	☐	Type reference (TYPE)	SO_OBJ_TP		Betriebswirtschaftlicher Schlüssel	20001030
3	Importing	I_DOCYR	Call by reference	☐	Type reference (TYPE)	SO_OBJ_YR		Betriebswirtschaftlicher Schlüssel	20001030
4	Importing	I_ENCCNT	Call by reference	☑	Type reference (TYPE)	SO_ENC_CNT		Persistentes Attribut	20010125
5	Importing	I_EXTCT	Call by reference	☑	Type reference (TYPE)	SO_EXTCT		Persistentes Attribut	20010125
6	Importing	I_FILE_EXT	Call by reference	☑	Type reference (TYPE)	SO_FILEEXT		Persistentes Attribut	20010125
7	Importing	I_IMPORTANCE	Call by reference	☑	Type reference (TYPE)	SO_OBJ_PRI		Persistentes Attribut	20010125
8	Importing	I_OBJLEN	Call by reference	☑	Type reference (TYPE)	SO_OBJ_LEN		Persistentes Attribut	20010125
9	Importing	I_SENSITIVITY	Call by reference	☑	Type reference (TYPE)	SO_OBJ_SNS		Persistentes Attribut	20010125
10	Importing	I_SUBJECT	Call by reference	☑	Type reference (TYPE)	SO_OBJ_DES		Persistentes Attribut	20010125
11	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_DOCUMENT_BCS		Neu erzeugtes transientes Objekt	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_EXISTING	☐	Object Services Exception	20010125

Method DELETE_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCNO	Call by reference	☐	Type reference (TYPE)	SO_OBJ_NO		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_DOCTP	Call by reference	☐	Type reference (TYPE)	SO_OBJ_TP		Betriebswirtschaftlicher Schlüssel	20001030
3	Importing	I_DOCYR	Call by reference	☐	Type reference (TYPE)	SO_OBJ_YR		Betriebswirtschaftlicher Schlüssel	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_EXISTING	☐	Object Services Exception	20010125

Method GET_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCNO	Call by reference	☐	Type reference (TYPE)	SO_OBJ_NO		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_DOCTP	Call by reference	☐	Type reference (TYPE)	SO_OBJ_TP		Betriebswirtschaftlicher Schlüssel	20001030
3	Importing	I_DOCYR	Call by reference	☐	Type reference (TYPE)	SO_OBJ_YR		Betriebswirtschaftlicher Schlüssel	20001030
4	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_DOCUMENT_BCS		Persistentes Objekt	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010125

Method GET_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DOCNO	Call by reference	☐	Type reference (TYPE)	SO_OBJ_NO		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_DOCTP	Call by reference	☐	Type reference (TYPE)	SO_OBJ_TP		Betriebswirtschaftlicher Schlüssel	20001030
3	Importing	I_DOCYR	Call by reference	☐	Type reference (TYPE)	SO_OBJ_YR		Betriebswirtschaftlicher Schlüssel	20001030
4	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_DOCUMENT_BCS		Transientes Objekt	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010125

Method MAP_EXTRACT_IDENTIFIER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_BUSINESS_KEY	Value transfer	☐	Type reference (TYPE)	TYP_BUSINESS_KEY		aus DB-Daten extrahierte betriebswirtsch. Schlüssel	20001030
2	Exporting	E_OID	Value transfer	☐	Type reference (TYPE)	TYP_OID		aus DB-Daten extrahierte OID	20001030
3	Importing	I_DB_DATA	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA		Von der DB gelesene Objektdaten	20001030

Method MAP_EXTRACT_IDENTIFIER on class CB_DOCUMENT_BCS has no exception.

Method MAP_GET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	E_OBJECT_DATA_TAB	Value transfer	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		ausgelesene Objektdaten	20001030
2	Importing	I_OBJECT_REF_TAB	Call by reference	☐	Type reference (TYPE)	TYP_OBJECT_REF_TAB		Liste der betroffenen Objekte	20001030

Method MAP_GET_ATTRIBUTES on class CB_DOCUMENT_BCS has no exception.

Method MAP_LOAD_FROM_DATABASE_GUID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OID_TAB	Call by reference	☐	Type reference (TYPE)	TYP_OID_TAB		OIDs der zu ladenden Daten	20001030
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		von DB gelesene Objektdaten	20001030

Method MAP_LOAD_FROM_DATABASE_GUID on class CB_DOCUMENT_BCS has no exception.

Method MAP_LOAD_FROM_DATABASE_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUSINESS_KEY_TAB	Call by reference	☐	Type reference (TYPE)	TYP_BUSINESS_KEY_TAB		Betriebswirt. Schlüssel der zu ladenden Daten	20001030
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		von DB gelesene Objektdaten	20001030

Method MAP_LOAD_FROM_DATABASE_KEY on class CB_DOCUMENT_BCS has no exception.

Method MAP_MERGE_IDENTIFIER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	C_DB_DATA_TAB	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Objekdaten, in die Identifikatoren zu mischen sind	20001030
2	Importing	I_BUSINESS_KEY_TAB	Call by reference	☐	Type reference (TYPE)	TYP_BUSINESS_KEY_TAB		Liste von betriebswirtsch. Schlüsseln	20001030
3	Importing	I_OID_TAB	Call by reference	☐	Type reference (TYPE)	TYP_OID_TAB		Liste von OIDs	20001030

Method MAP_MERGE_IDENTIFIER on class CB_DOCUMENT_BCS has no exception.

Method MAP_SAVE_TO_DATABASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_DELETES	Call by reference	☐	Type reference (TYPE)	TYP_DB_DELETE_TAB		Schlüssel der zu löschenden Daten	20001030
2	Importing	I_INSERTS	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Neu anzulegende Daten	20001030
3	Importing	I_UPDATES	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Zu ändernde Daten	20001030

Method MAP_SAVE_TO_DATABASE on class CB_DOCUMENT_BCS has no exception.

Method MAP_SERIALIZE_BKEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUSINESS_KEY	Call by reference	☐	Type reference (TYPE)	TYP_BUSINESS_KEY		Business Key	20010125
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Business Key als String	20010125

Method MAP_SERIALIZE_BKEY on class CB_DOCUMENT_BCS has no exception.

Method MAP_SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA		zu setzende Objektdaten	20001030
2	Importing	I_OBJECT_REF	Call by reference	☐	Type reference (TYPE)	TYP_OBJECT_REF		Betroffenes Objekt	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010125

Method PM_CHECK_AND_SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUSINESS_KEY	Call by reference	☑	Type reference (TYPE)	TYP_BUSINESS_KEY		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_ID_PROVIDED	Call by reference	☑	Type reference (TYPE)	TYP_ID_STATUS	0	Mit welchen Identifikatoren wurde geladen und geprüft	20001030
3	Importing	I_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA		Von DB geladene Daten	20001030
4	Importing	I_OID	Call by reference	☑	Type reference (TYPE)	TYP_OID		allgemeiner Objektidentifikator	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010125

Method PM_CREATE_REPRESENTANT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUSINESS_KEY	Call by reference	☑	Type reference (TYPE)	TYP_BUSINESS_KEY		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_OID	Call by reference	☑	Type reference (TYPE)	TYP_OID		allgemeiner Objektidentifikator	20001030
3	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_OBJECT_REF		Neu erzeugtes Hüllenobjekt	20001030

Method PM_CREATE_REPRESENTANT on class CB_DOCUMENT_BCS has no exception.

Method PM_DELETE_PERSISTENT Signature

Method PM_DELETE_PERSISTENT on class CB_DOCUMENT_BCS has no parameter.
Method PM_DELETE_PERSISTENT on class CB_DOCUMENT_BCS has no exception.

Method PM_LOAD_AND_SET_ATTRIBUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BUSINESS_KEY	Call by reference	☑	Type reference (TYPE)	TYP_BUSINESS_KEY		Betriebswirtschaftlicher Schlüssel	20001030
2	Importing	I_OID	Call by reference	☑	Type reference (TYPE)	TYP_OID		allgemeiner Objektidentifikator	20001030

#	Exception	Resumable	Description	Created on
1	CX_OS_OBJECT_NOT_FOUND	☐	Object Services Exception	20010125

History

Last changed by/on	SAP	20000124
SAP Release Created in	50A