SAP ABAP Class /SCMB/CB_DF_DOC (Document Flow Base Agent: Document Identification)

Hierarchy

☛ PI_BASIS (Software Component) Basis Plug-In
   ⤷ SCM-BAS-DF (Application Component) Cross-System and Cross-Partner Document Flow
     ⤷ /SCMB/FLOW_DOCUMENT (Package) Document Flow, Document Administration

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	20020923

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	/SCMB/CA_DF_DOC	Document Flow Agent: Document Identification	20020923

Properties

Class	/SCMB/CB_DF_DOC
Short Description	Document Flow Base Agent: Document Identification
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
Category	11	Factory for Persistent Class
Package	/SCMB/FLOW_DOCUMENT	Document Flow, Document Administration
Created	20020923	SAP
Last change	20131127	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class /SCMB/CB_DF_DOC has no forward declaration.

Interfaces

Class /SCMB/CB_DF_DOC has no interface implemented.

Friends

Class /SCMB/CB_DF_DOC 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	20020923
2	SPECIAL_BKEY_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_BKEY_TAB		Class-Specific: Search Table Business Keys	20020923
3	SPECIAL_OBJECT_INFO	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_OBJECT_INFO_TAB		Class-Specific Object Data	20020923

Methods

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

Events

Class /SCMB/CB_DF_DOC has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_BUSINESS_KEY	Protected	See coding		Business Key	20020923	begin of TYP_BUSINESS_KEY , GUID type /SCMB/DF_GUID , end of TYP_BUSINESS_KEY
2	TYP_BUSINESS_KEY_TAB	Protected	See coding	TYP_BUSINESS_KEY	Table Type Object Reference	20020923	TYP_BUSINESS_KEY_TAB type standard table of TYP_BUSINESS_KEY with non-unique default key
3	TYP_DB_DATA	Protected	See coding		Row Type Persistent Object Data	20020923	begin of TYP_DB_DATA , BOR_ID type SIBFBORIID , BOR_TYPE type SIBFTYPEID , BSKEY type SLD_BSKEY , CATEGORY type /SCMB/DF_CATEGORY , CHARACTERISTIC type /SCMB/STRINGVAL , CHARACTERISTICX type /SCMB/XSTRINGVAL , GUID type /SCMB/DF_GUID , GUID_APP type /SCMB/DF_GUID , LOGSYS type LOGSYS , end of TYP_DB_DATA
4	TYP_DB_DATA_TAB	Protected	See coding	TYP_DB_DATA	Table Type Persistent Object Data	20020923	TYP_DB_DATA_TAB type standard table of TYP_DB_DATA with non-unique default key
5	TYP_DB_DELETE_TAB	Protected	See coding	TYP_SPECIAL_OBJECT_INFO	Table Type Identifiers to Delete	20020923	TYP_DB_DELETE_TAB type standard table of TYP_SPECIAL_OBJECT_INFO with non-unique default key
6	TYP_OBJECT_REF	Protected	Object reference (TYPE REF TO)	/SCMB/CL_DF_DOC	Category of Managed Object	20020923
7	TYP_OBJECT_REF_TAB	Protected	See coding	TYP_OBJECT_REF	Table Type Object Reference	20020923	TYP_OBJECT_REF_TAB type standard table of TYP_OBJECT_REF with non-unique default key
8	TYP_OID	Protected	Type reference (TYPE)	OS_GUID	Category of Generic Object Identifier	20020923
9	TYP_OID_TAB	Protected	See coding	TYP_OID	Table Type Object Identifier	20020923	TYP_OID_TAB type standard table of TYP_OID with non-unique default key
10	TYP_SPECIAL_BKEY_TAB	Protected	See coding	TYP_SPECIAL_OBJECT_INFO	Table Type Search Table Business Keys	20020923	TYP_SPECIAL_BKEY_TAB type sorted table of TYP_SPECIAL_OBJECT_INFO with unique key BUSINESS_KEY
11	TYP_SPECIAL_OBJECT_INFO	Protected	See coding		Row Type Class-Specific Object Data	20020923	begin of TYP_SPECIAL_OBJECT_INFO , OBJECT_ID type TYP_INTERNAL_OID , ID_STATUS type TYP_ID_STATUS , BUSINESS_KEY type TYP_BUSINESS_KEY , end of TYP_SPECIAL_OBJECT_INFO
12	TYP_SPECIAL_OBJECT_INFO_TAB	Protected	See coding	TYP_SPECIAL_OBJECT_INFO	Table Type Class-Specific Object Data	20020923	TYP_SPECIAL_OBJECT_INFO_TAB type sorted table of TYP_SPECIAL_OBJECT_INFO with unique key OBJECT_ID
13	TYP_TYPE	Protected	Type reference (TYPE)	OS_GUID	Category of Type Identifier	20020923

Method Signatures

Method CREATE_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BOR_ID	Call by reference	☑	Type reference (TYPE)	SIBFBORIID		Persistentes Attribut	20020923
2	Importing	I_BOR_TYPE	Call by reference	☑	Type reference (TYPE)	SIBFTYPEID		Persistentes Attribut	20020923
3	Importing	I_BSKEY	Call by reference	☑	Type reference (TYPE)	SLD_BSKEY		Persistentes Attribut	20031007
4	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_CATEGORY		Persistentes Attribut	20020923
5	Importing	I_CHARACTERISTIC	Call by reference	☑	Type reference (TYPE)	/SCMB/STRINGVAL		Persistentes Attribut	20021002
6	Importing	I_CHARACTERISTICX	Call by reference	☑	Type reference (TYPE)	/SCMB/XSTRINGVAL			20130211
7	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_GUID		Betriebswirtschaftlicher Schlüssel	20021002
8	Importing	I_GUID_APP	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_GUID		Persistentes Attribut	20020923
9	Importing	I_LOGSYS	Call by reference	☑	Type reference (TYPE)	LOGSYS		Persistentes Attribut	20020923
10	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_DOC		Neu erzeugtes persistentes Objekt	20020923

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

Method CREATE_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BOR_ID	Call by reference	☑	Type reference (TYPE)	SIBFBORIID		Persistentes Attribut	20020923
2	Importing	I_BOR_TYPE	Call by reference	☑	Type reference (TYPE)	SIBFTYPEID		Persistentes Attribut	20020923
3	Importing	I_BSKEY	Call by reference	☑	Type reference (TYPE)	SLD_BSKEY		Persistentes Attribut	20031007
4	Importing	I_CATEGORY	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_CATEGORY		Persistentes Attribut	20020923
5	Importing	I_CHARACTERISTIC	Call by reference	☑	Type reference (TYPE)	/SCMB/STRINGVAL		Persistentes Attribut	20021002
6	Importing	I_CHARACTERISTICX	Call by reference	☑	Type reference (TYPE)	/SCMB/XSTRINGVAL			20130211
7	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_GUID		Betriebswirtschaftlicher Schlüssel	20021002
8	Importing	I_GUID_APP	Call by reference	☑	Type reference (TYPE)	/SCMB/DF_GUID		Persistentes Attribut	20020923
9	Importing	I_LOGSYS	Call by reference	☑	Type reference (TYPE)	LOGSYS		Persistentes Attribut	20020923
10	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_DOC		Neu erzeugtes transientes Objekt	20020923

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

Method DELETE_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_GUID		Betriebswirtschaftlicher Schlüssel	20021002

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

Method GET_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_GUID		Betriebswirtschaftlicher Schlüssel	20021002
2	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_DOC		Persistentes Objekt	20020923

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

Method GET_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_GUID	Call by reference	☐	Type reference (TYPE)	/SCMB/DF_GUID		Betriebswirtschaftlicher Schlüssel	20021002
2	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	/SCMB/CL_DF_DOC		Transientes Objekt	20020923

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

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	20020923
2	Importing	I_DB_DATA	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA		Von der DB gelesene Objektdaten	20020923

Method MAP_EXTRACT_IDENTIFIER on class /SCMB/CB_DF_DOC 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	20020923
2	Importing	I_OBJECT_REF_TAB	Call by reference	☐	Type reference (TYPE)	TYP_OBJECT_REF_TAB		Liste der betroffenen Objekte	20020923

Method MAP_GET_ATTRIBUTES on class /SCMB/CB_DF_DOC 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	20020923
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		von DB gelesene Objektdaten	20020923

Method MAP_LOAD_FROM_DATABASE_KEY on class /SCMB/CB_DF_DOC 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	20020923
2	Importing	I_BUSINESS_KEY_TAB	Call by reference	☐	Type reference (TYPE)	TYP_BUSINESS_KEY_TAB		Liste von betriebswirtsch. Schlüsseln	20020923

Method MAP_MERGE_IDENTIFIER on class /SCMB/CB_DF_DOC 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	20020923
2	Importing	I_INSERTS	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Neu anzulegende Daten	20020923
3	Importing	I_UPDATES	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Zu ändernde Daten	20020923

Method MAP_SAVE_TO_DATABASE on class /SCMB/CB_DF_DOC 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	20020923
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Business Key als String	20020923

Method MAP_SERIALIZE_BKEY on class /SCMB/CB_DF_DOC 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	20020923
2	Importing	I_OBJECT_REF	Call by reference	☐	Type reference (TYPE)	TYP_OBJECT_REF		Betroffenes Objekt	20020923

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

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	20020923
2	Importing	I_ID_PROVIDED	Call by reference	☑	Type reference (TYPE)	TYP_ID_STATUS	0	Mit welchen Identifikatoren wurde geladen und geprüft	20020923
3	Importing	I_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA		Von DB geladene Daten	20020923

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

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	20020923
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_OBJECT_REF		Neu erzeugtes Hüllenobjekt	20020923

Method PM_CREATE_REPRESENTANT on class /SCMB/CB_DF_DOC has no exception.

Method PM_DELETE_PERSISTENT Signature

Method PM_DELETE_PERSISTENT on class /SCMB/CB_DF_DOC has no parameter.
Method PM_DELETE_PERSISTENT on class /SCMB/CB_DF_DOC 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	20020923

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

History

Last changed by/on	SAP	20131127
SAP Release Created in	401