SAP ABAP Class CL_EXM_DG_TARGET_BASE (EPM: Abstract base class for EPM/ESM targets)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-NWD (Application Component) NetWeaver Demonstration
     ⤷ S_EPM_DG (Package) EPM: New Data Generator

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_EPM_DG_TARGET_BASE	EPM: New data generator base target class	20100630
2	Inheritance (c INHERITING FROM c_ref)	CL_NON_EPM_DG_TARGET_BASE	EPM: Non-EPM target base class ( for testing only )	20100811

Properties

Class	CL_EXM_DG_TARGET_BASE
Short Description	EPM: Abstract base class for EPM/ESM targets
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	S_EPM_DG	EPM: New Data Generator
Created	20100628	SAP
Last change	20140121	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)
2	CL_EXM_DG_CHANNEL_BASE	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_EXM_DG_CONFIG_UTILITIES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

Class CL_EXM_DG_TARGET_BASE has no interface implemented.

Friends

Class CL_EXM_DG_TARGET_BASE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GV_TARGET_DESCRIPTION	Static Attribute	Public	☐	Type reference (TYPE)	TY_TARGET_DESCRIPTION		Description of data generation target	20100628
2	MV_PACKAGE_SIZE	Instance attribute	Public	☐	Type reference (TYPE)	I	2000		20110607

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CREATE_SNAPSHOT	Instance method	Public	Method	Save a snapshot (the momentary status) of the target	20100830
2	DELETE_ALL_DATA	Instance method	Public	Method	Delete all data	20101202
3	DELETE_ALL_SNAPSHOTS	Instance method	Public	Method	Delete all snapshots of the target	20100823
4	DELETE_EXM_DATA	Instance method	Public	Method	Generic DELETE method for EXM data	20100628
5	DELETE_SNAPSHOT	Instance method	Public	Method	Delete the specified snapshot	20100823
6	FINALIZE	Instance method	Public	Method	Finalize	20100628
7	GET_EXM_CHILD_KEYS	Instance method	Public	Method	Generic GET method for EXM field data	20110419
8	GET_EXM_DATA	Instance method	Public	Method	Generic GET method for EXM data	20100628
9	GET_EXM_FIELD_DATA	Instance method	Public	Method	Generic GET method for EXM field data	20110401
10	GET_EXM_KEYS	Instance method	Public	Method	Generic GET method for EXM node keys	20100708
11	GET_MESSAGES	Instance method	Public	Method	Get messages to give to e.g. UI	20100817
12	GET_NR_STATUS	Instance method	Public	Method	Generic GET method for EXM number range	20101117
13	GET_SNAPSHOT_KEYS	Instance method	Public	Method	Retrieve the keys of all stored snapshots	20100827
14	GET_TARGET_PARAMS	Instance method	Public	Method	Return this target's parameters	20111108
15	INITIALIZE	Instance method	Public	Method	Generic initialization method	20100628
16	RETRIEVE_SNAPSHOT	Instance method	Public	Method	Retrieve a saved snapshot of the target	20100823
17	SNAPSHOT_FACILITY_ENABLED	Instance method	Public	Method	Return whether target can create data snapshots	20100830
18	STORE_EXM_DATA	Instance method	Public	Method	Generic STORE method for EXM data	20100628

Events

Class CL_EXM_DG_TARGET_BASE has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TT_SNAPSHOT_KEYS	Public	See coding			20100908	tt_snapshot_keys TYPE STANDARD TABLE OF ty_snapshot_key
2	TT_TARGET_INFO	Public	See coding		Admin info table	20100628	tt_target_info TYPE HASHED TABLE OF ty_target_info WITH UNIQUE KEY target_name
3	TT_TARGET_NAMES	Public	See coding			20100628	tt_target_names TYPE HASHED TABLE OF ty_target_name WITH UNIQUE KEY table_line
4	TY_NON_EXM_DATA_TYPE	Public	Type reference (TYPE)	INT4		20100628
5	TY_SNAPSHOT_KEY	Public	See coding			20100908	BEGIN OF ty_snapshot_key, guid TYPE sysuuid_c, channel_name TYPE cl_exm_dg_channel_base=>ty_channel_name, target_name TYPE ty_target_name, description(255) TYPE c, created_by TYPE syuname, created_at TYPE timestampl, END OF ty_snapshot_key
6	TY_TARGET_DESCRIPTION	Public	Type reference (TYPE)	STRING	Description of data generation target	20100628
7	TY_TARGET_INFO	Public	See coding		Admin info	20100628	BEGIN OF ty_target_info, target_name TYPE ty_target_name, target_type TYPE ty_target_type, description TYPE ty_target_description, END OF ty_target_info
8	TY_TARGET_NAME	Public	Type reference (TYPE)	STRING	Name of data generation target	20100628
9	TY_TARGET_TYPE	Public	Type reference (TYPE)	STRING	Data generation target type (ESM/EPM etc.)	20100628

Method Signatures

Method CREATE_SNAPSHOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	STRINGTAB		Table with Strings	20100908
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100830
3	Importing	IV_CHANNEL_NAME	Call by reference	☐	Type reference (TYPE)	CL_EXM_DG_CHANNEL_BASE=>TY_CHANNEL_NAME		Name of data generation channel	20100906
4	Importing	IV_SNAPSHOT_DESCRIPTION	Call by reference	☐	Type reference (TYPE)	CHAR255		Char255	20100906
5	Importing	IV_SNAPSHOT_KEY	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in character form	20100906

Method CREATE_SNAPSHOT on class CL_EXM_DG_TARGET_BASE has no exception.

Method DELETE_ALL_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	STRINGTAB		Table with Strings	20101202
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20101202

Method DELETE_ALL_DATA on class CL_EXM_DG_TARGET_BASE has no exception.

Method DELETE_ALL_SNAPSHOTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	STRINGTAB		Table with Strings	20100908
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100823

Method DELETE_ALL_SNAPSHOTS on class CL_EXM_DG_TARGET_BASE has no exception.

Method DELETE_EXM_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Op status	20100628
2	Importing	IT_NODE_KEYS	Call by reference	☑	Type reference (TYPE)	STANDARD TABLE		Keys of records	20100628
3	Importing	IV_BO_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME		Name of business object	20100628
4	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME		Name of business object	20100628

Method DELETE_EXM_DATA on class CL_EXM_DG_TARGET_BASE has no exception.

Method DELETE_SNAPSHOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	STRINGTAB		Table with Strings	20100908
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100823
3	Importing	IV_SNAPSHOT_KEY	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in character form	20100906

Method DELETE_SNAPSHOT on class CL_EXM_DG_TARGET_BASE has no exception.

Method FINALIZE Signature

Method FINALIZE on class CL_EXM_DG_TARGET_BASE has no parameter.
Method FINALIZE on class CL_EXM_DG_TARGET_BASE has no exception.

Method GET_EXM_CHILD_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CHILD_KEYS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20110419
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110419
3	Importing	IT_PARENT_KEYS	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Table with Strings	20110419
4	Importing	IV_BO_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20110419
5	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20110419

Method GET_EXM_CHILD_KEYS on class CL_EXM_DG_TARGET_BASE has no exception.

Method GET_EXM_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	ANY TABLE			20100628
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100628
3	Importing	IT_NODE_KEYS	Call by reference	☑	Type reference (TYPE)	ANY TABLE			20100628
4	Importing	IV_BO_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20100628
5	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20100628

Method GET_EXM_DATA on class CL_EXM_DG_TARGET_BASE has no exception.

Method GET_EXM_FIELD_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20110401
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20110401
3	Importing	IT_NODE_KEYS	Call by reference	☑	Type reference (TYPE)	STANDARD TABLE		Table with Strings	20110401
4	Importing	IV_BO_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20110401
5	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20110401
6	Importing	IV_FIELD_NAME	Call by reference	☐	Type reference (TYPE)	CHAR16			20110401

Method GET_EXM_FIELD_DATA on class CL_EXM_DG_TARGET_BASE has no exception.

Method GET_EXM_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE			20100708
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100708
3	Importing	IV_BO_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20100708
4	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20100708

Method GET_EXM_KEYS on class CL_EXM_DG_TARGET_BASE has no exception.

Method GET_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	STRINGTAB		Table with Strings	20100817

#	Exception	Resumable	Description	Created on
1	CX_EXM_API_EXCEPTION	☐	EPM: API exception class	20121029

Method GET_NR_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_MAX_NUM	Call by reference	☐	Type reference (TYPE)	SNWD_ID		EPM: Employee ID	20101117
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20101117
3	Importing	IV_BO_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20101117
4	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME			20101117

Method GET_NR_STATUS on class CL_EXM_DG_TARGET_BASE has no exception.

Method GET_SNAPSHOT_KEYS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SNAPSHOT_KEYS	Call by reference	☐	Type reference (TYPE)	TT_SNAPSHOT_KEYS			20100827
2	Importing	IV_CHANNEL_NAME	Call by reference	☑	Type reference (TYPE)	CL_EXM_DG_CHANNEL_BASE=>TY_CHANNEL_NAME		Name of data generation channel	20100906

Method GET_SNAPSHOT_KEYS on class CL_EXM_DG_TARGET_BASE has no exception.

Method GET_TARGET_PARAMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_PARAMS	Call by reference	☐	Type reference (TYPE)	CL_EXM_DG_CONFIG_UTILITIES=>TT_DG_PARAMS			20111108

Method GET_TARGET_PARAMS on class CL_EXM_DG_TARGET_BASE has no exception.

Method INITIALIZE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100628
2	Importing	IT_PARAMETERS	Call by reference	☑	Type reference (TYPE)	CL_EXM_DG_CONFIG_UTILITIES=>TT_DG_PARAMS			20111107

Method INITIALIZE on class CL_EXM_DG_TARGET_BASE has no exception.

Method RETRIEVE_SNAPSHOT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGES	Call by reference	☐	Type reference (TYPE)	STRINGTAB		Table with Strings	20100908
2	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20100823
3	Importing	IV_SNAPSHOT_KEY	Call by reference	☐	Type reference (TYPE)	SYSUUID_C		UUID in character form	20100823

Method RETRIEVE_SNAPSHOT on class CL_EXM_DG_TARGET_BASE has no exception.

Method SNAPSHOT_FACILITY_ENABLED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	EV_ENABLED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20110505

Method SNAPSHOT_FACILITY_ENABLED on class CL_EXM_DG_TARGET_BASE has no exception.

Method STORE_EXM_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SUCCESS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Op status	20100628
2	Importing	IT_DATA	Call by reference	☐	Type reference (TYPE)	STANDARD TABLE		Data block to be stored	20100628
3	Importing	IV_BO_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME		Name of business object	20100628
4	Importing	IV_BO_NODE_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_INTFNAME		Name of business object	20100628

#	Exception	Resumable	Description	Created on
1	CX_EXM_API_EXCEPTION	☐	EPM/ESM data generator exceptions	20101007

History

Last changed by/on	SAP	20140121
SAP Release Created in	703