SAP ABAP Class CB_ABAP_CC_ATL_USER (Base agent ABAP Code Completion: User Template Persistent Ob)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-ABA-LA (Application Component) Syntax, Compiler, Runtime
     ⤷ S_CODE_COMPLETION_ATL (Package) ABAP Code Completion - ABAP Template Language Processing

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	20060613

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CA_ABAP_CC_ATL_USER	Agent ABAP Code Completion: User Template Persistent Object	20060613

Properties

Class	CB_ABAP_CC_ATL_USER
Short Description	Base agent ABAP Code Completion: User Template Persistent Ob
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	S_CODE_COMPLETION_ATL	ABAP Code Completion - ABAP Template Language Processing
Created	20060613	SAP
Last change	20110908	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CB_ABAP_CC_ATL_USER has no forward declaration.

Interfaces

Class CB_ABAP_CC_ATL_USER has no interface implemented.

Friends

Class CB_ABAP_CC_ATL_USER 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	20060613
2	MAP_ATT_INFO_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	OSTYP_RT_MAP_ATT_INFO_SRT_TAB		Query: Mapping Metadata for Attributes	20060613
3	SPECIAL_BKEY_TAB	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_BKEY_TAB		Class-Specific: Search Table Business Keys	20060613
4	SPECIAL_OBJECT_INFO	Instance attribute	Protected	☐	Type reference (TYPE)	TYP_SPECIAL_OBJECT_INFO_TAB		Class-Specific Object Data	20060613

Methods

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

Events

Class CB_ABAP_CC_ATL_USER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TYP_BUSINESS_KEY	Protected	See coding		Business Key	20060613	begin of TYP_BUSINESS_KEY , BNAME type XUBNAME , TEMPLATE type EX_CI_VAL , end of TYP_BUSINESS_KEY
2	TYP_BUSINESS_KEY_TAB	Protected	See coding	TYP_BUSINESS_KEY	Table Type Object Reference	20060613	TYP_BUSINESS_KEY_TAB type standard table of TYP_BUSINESS_KEY with non-unique default key
3	TYP_DB_DATA	Protected	See coding		Line-Type Persistent Object Data	20060613	begin of TYP_DB_DATA , ACTIVE type BOOLEAN , BNAME type XUBNAME , TEMPLATE type EX_CI_VAL , TEMPLATE_CONTENT type SCC_ATL_TEMPLATE_CONTENT , end of TYP_DB_DATA
4	TYP_DB_DATA_TAB	Protected	See coding	TYP_DB_DATA	Table-Type Persistent Object Data	20060613	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	20060613	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)	CL_ABAP_CC_ATL_USER	Type of Managed Object	20060613
7	TYP_OBJECT_REF_TAB	Protected	See coding	TYP_OBJECT_REF	Table Type Object Reference	20060613	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	Type of Generic Object Identifier	20060613
9	TYP_OID_TAB	Protected	See coding	TYP_OID	Table Type Object Identifier	20060613	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	20060613	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		Line Type Class-Specific Object Data	20060613	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	20060613	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	Type of Type Identifier	20060613

Method Signatures

Method CREATE_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVE	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Persistent Attribute	20060613
2	Importing	I_BNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME		Business Key	20060613
3	Importing	I_TEMPLATE	Call by reference	☐	Type reference (TYPE)	EX_CI_VAL		Business Key	20060613
4	Importing	I_TEMPLATE_CONTENT	Call by reference	☑	Type reference (TYPE)	SCC_ATL_TEMPLATE_CONTENT		Persistent Attribute	20060613
5	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_CC_ATL_USER		Newly Generated Persistent Object	20060613

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

Method CREATE_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ACTIVE	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Persistent Attribute	20060613
2	Importing	I_BNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME		Business Key	20060613
3	Importing	I_TEMPLATE	Call by reference	☐	Type reference (TYPE)	EX_CI_VAL		Business Key	20060613
4	Importing	I_TEMPLATE_CONTENT	Call by reference	☑	Type reference (TYPE)	SCC_ATL_TEMPLATE_CONTENT		Persistent Attribute	20060613
5	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_CC_ATL_USER		Newly Generated Transient Object	20060613

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

Method DELETE_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME		Business Key	20060613
2	Importing	I_TEMPLATE	Call by reference	☐	Type reference (TYPE)	EX_CI_VAL		Business Key	20060613

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

Method GET_PERSISTENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME		Business Key	20060613
2	Importing	I_TEMPLATE	Call by reference	☐	Type reference (TYPE)	EX_CI_VAL		Business Key	20060613
3	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_CC_ATL_USER		Persistent Object	20060613

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

Method GET_TRANSIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_BNAME	Call by reference	☐	Type reference (TYPE)	XUBNAME		Business Key	20060613
2	Importing	I_TEMPLATE	Call by reference	☐	Type reference (TYPE)	EX_CI_VAL		Business Key	20060613
3	Returning	RESULT	Value transfer	☐	Object reference (TYPE REF TO)	CL_ABAP_CC_ATL_USER		Transient Object	20060613

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

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		Business Key Extracted from Database Data	20060613
2	Importing	I_DB_DATA	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA		Object Data Read from DB	20060613

Method MAP_EXTRACT_IDENTIFIER on class CB_ABAP_CC_ATL_USER 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		Object Data Read	20060613
2	Importing	I_OBJECT_REF_TAB	Call by reference	☐	Type reference (TYPE)	TYP_OBJECT_REF_TAB		List of Objects Affected	20060613

Method MAP_GET_ATTRIBUTES on class CB_ABAP_CC_ATL_USER has no exception.

Method MAP_INITIALIZE_METADATA Signature

Method MAP_INITIALIZE_METADATA on class CB_ABAP_CC_ATL_USER has no parameter.
Method MAP_INITIALIZE_METADATA on class CB_ABAP_CC_ATL_USER has no exception.

Method MAP_LOAD_FROM_DATABASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	I_ORDER_BY_CLAUSE	Call by reference	☑	Type reference (TYPE)	STRING		ORDER BY Clause	20060613
2	Importing	I_SUBCLASSES	Call by reference	☐	Type reference (TYPE)	OS_BOOLEAN	OSCON_FALSE	Load Subclass Instances	20060613
3	Importing	I_UPTO	Call by reference	☐	Type reference (TYPE)	I	0	Max. No. Instances	20060613
4	Importing	I_WHERE_CLAUSE	Call by reference	☑	Type reference (TYPE)	STRING		Where Clause	20060613
5	Importing	PAR1	Call by reference	☑	Type reference (TYPE)	ANY		First Parameter for Query Execution	20060613
6	Importing	PAR2	Call by reference	☑	Type reference (TYPE)	ANY		Second Parameter for Query Execution	20060613
7	Importing	PAR3	Call by reference	☑	Type reference (TYPE)	ANY		Third Parameter for Query Execution	20060613
8	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Object Data Read from the Database	20060613

Method MAP_LOAD_FROM_DATABASE on class CB_ABAP_CC_ATL_USER 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		Business Key of the Data to Be Loaded	20060613
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Object Data Read from the Database	20060613

Method MAP_LOAD_FROM_DATABASE_KEY on class CB_ABAP_CC_ATL_USER 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		Object Data in Which Identifiers Are to Be Mixed	20060613
2	Importing	I_BUSINESS_KEY_TAB	Call by reference	☐	Type reference (TYPE)	TYP_BUSINESS_KEY_TAB		List of Business Keys	20060613

Method MAP_MERGE_IDENTIFIER on class CB_ABAP_CC_ATL_USER 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		Key of the Data to Be Deleted	20060613
2	Importing	I_INSERTS	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Data to Be Created	20060613
3	Importing	I_UPDATES	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA_TAB		Data to Be Changed	20060613

Method MAP_SAVE_TO_DATABASE on class CB_ABAP_CC_ATL_USER 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	20060613
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	STRING		Business Key as String	20060613

Method MAP_SERIALIZE_BKEY on class CB_ABAP_CC_ATL_USER 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		Object Data to Be Set	20060613
2	Importing	I_OBJECT_REF	Call by reference	☐	Type reference (TYPE)	TYP_OBJECT_REF		Object Affected	20060613

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

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		Business Key	20060613
2	Importing	I_ID_PROVIDED	Call by reference	☑	Type reference (TYPE)	TYP_ID_STATUS	0	With Which Identifiers Were Loading and Checking Performed	20060613
3	Importing	I_OBJECT_DATA	Call by reference	☐	Type reference (TYPE)	TYP_DB_DATA		Data Loaded from Database	20060613

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

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		Business Key	20060613
2	Returning	RESULT	Value transfer	☐	Type reference (TYPE)	TYP_OBJECT_REF		Newly Generated Wrapper Object	20060613

Method PM_CREATE_REPRESENTANT on class CB_ABAP_CC_ATL_USER has no exception.

Method PM_DELETE_PERSISTENT Signature

Method PM_DELETE_PERSISTENT on class CB_ABAP_CC_ATL_USER has no parameter.
Method PM_DELETE_PERSISTENT on class CB_ABAP_CC_ATL_USER 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		Business Key	20060613

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

History

Last changed by/on	SAP	20110908
SAP Release Created in	710