SAP ABAP Class /UI2/CL_TM_INDEX_SHR (Shared object for target mapping index access)

Hierarchy

☛

SAP_UI (Software Component) User Interface Technology
⤷

CA-UI2-INT-BE (Application Component) Backend Enablement
⤷

/UI2/BASIS_SERVICES_INTEROP (Package) UI BE: Interface Interoperability Service

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_SHM_BUILD_INSTANCE	Flag Interface: Area Constructor for Shared Objects	20140428

Properties

Class	/UI2/CL_TM_INDEX_SHR
Short Description	Shared object for target mapping index access
Super Class
Instantiability of a Class	1	Protected
Final

General Data

Message Class
Program status
Category	0
Package	/UI2/BASIS_SERVICES_INTEROP	UI BE: Interface Interoperability Service
Created	20140428	SAP
Last change	20141120
Shared Memory-enabled
Fixed point arithmetic
Unicode checks active

Forward declarations

#	Type group / Object type	Type	Type Description
1	/UI2/CL_TM_INDEX_SHR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
2	/UI2/IF_NAVIGATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
3	/UI2/IF_TM_INDEX_ACCESS	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
4	ABAP	Type group use (TYPE-POOLS tp)	Type group use (TYPE-POOLS tp)
5	CL_SHM_AREA	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_SHM_BUILD_INSTANCE			Flag Interface: Area Constructor for Shared Objects	20140428

Friends

Class /UI2/CL_TM_INDEX_SHR has no friend class.

Attributes

#	Attribute	Level	Visibility	Typing	Associated Type	Initial Value	Description	Created on
1	MC_DATA_HASH	Constant	Public	Type reference (TYPE)	STRING	'3'	Data invalidation flag	20140515
2	MT_CAT_TM_IDX	Instance attribute	Protected	Type reference (TYPE)	TT_TM_CAT_IDX			20140429
3	MT_CHIP_TM_IDX	Instance attribute	Protected	Type reference (TYPE)	TT_TM_CHIP_IDX			20140429
4	MT_ID_TM_IDX	Instance attribute	Protected	Type reference (TYPE)	TT_TM_ID_IDX			20140515
5	MT_TEXT	Instance attribute	Protected	Type reference (TYPE)	TT_TEXT			20140724
6	MT_TM	Instance attribute	Protected	Type reference (TYPE)	TT_TM			20140429
7	MT_USER_CATALOGS	Instance attribute	Protected	Type reference (TYPE)	TT_USER_CATALOGS			20140724
8	MV_TS	Instance attribute	Protected	Type reference (TYPE)	TIMESTAMP			20140429

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ATTACH_FOR_READ	Static method	Protected	Method	Attach for read and refresh if needed	20140428
2	CHIPID_FROM_TMID	Static method	Protected	Method	Read ChipID from TM ID	20140515
3	CLASS_CONSTRUCTOR	Static method	Public	Constructor	CLASS_CONSTRUCTOR	20140515
4	FILTER_BY_FORM_FACTOR	Static method	Public	Method	Filters target mapping using form factor	20140428
5	FILTER_BY_SIGNATURE	Static method	Public	Method	Filters target mapping using signature and intent parameters	20140428
6	GET_LAUNCHPAD_DETAILS	Static method	Protected	Method		20140505
7	GET_MY_CATALOGS	Static method	Public	Method	Returned list of my user catalogs	20140428
8	GET_MY_TARGETS	Static method	Public	Method	Returned filtered list of target mappings	20140429
9	GET_MY_TARGET_MAPPINGS	Static method	Public	Method	Returned filtered list of target mappings	20140428
10	GET_MY_TM_HASH	Static method	Public	Method	Returnes hash for user assigned target mappings	20140428
11	GET_TARGET_MAPPINGS	Static method	Public	Method	Returned filtered list of target mappings	20140428
12	GET_TEXT_FOR_TM	Static method	Protected	Method	Reads and caches WD text by ID if needed	20140724
13	GET_TM_ACCESS	Static method	Public	Method	Returns TM Access interface instance to be used by WD BADi	20140430
14	GET_TM_HASH	Static method	Public	Method	Returnes global target mapping index hash (timestamp)	20140428
15	INIT	Static method	Public	Method	Init index data	20140507
16	PARSE_SIGNATURE	Static method	Public	Method		20140428
17	PBS_HAS_CHANGED	Static method	Protected	Method	The method returns true, if any PBS transport has arrived	20140515
18	PREPARE_PARAMS	Static method	Public	Method		20140428
19	REBUILD_INDEXES	Static method	Protected	Method	Rebuild helper indexes	20140505
20	SELECT_TM_DATA	Static method	Protected	Method	Returned filtered list of target mappings	20140429
21	TRANSFORM	Static method	Public	Method	Transform raw data TM structure to runtime structure	20140513

Events

Class /UI2/CL_TM_INDEX_SHR has no event.

Types

#	Type	Visibility	Typing	Created on	Type Source
1	TP_S_TARGET	Public	See coding	20140514	`BEGIN OF tp_s_target, id TYPE string, text TYPE string, url TYPE string, application_type TYPE string, application_alias TYPE string, additional_data TYPE string, object TYPE string, action TYPE string, priority TYPE i, signature TYPE ts_sig_data, form_factors TYPE ts_form_factor, in_parameters TYPE tihttpnvp, lpd_id TYPE string, END OF tp_s_target`
2	TP_T_TARGET	Public	See coding	20140514	`tp_t_target TYPE STANDARD TABLE OF tp_s_target WITH KEY id`
3	TS_FORM_FACTOR	Public	See coding	20140428	`BEGIN OF ts_form_factor, desktop TYPE abap_bool, tablet TYPE abap_bool, phone TYPE abap_bool, END OF ts_form_factor`
4	TS_FORM_FACTOR_EX	Public	See coding	20140428	`BEGIN OF ts_form_factor_ex, app_default TYPE abap_bool, manual TYPE ts_form_factor, END OF ts_form_factor_ex`
5	TS_PARAM	Public	See coding	20140428	`BEGIN OF ts_param, name TYPE string, value TYPE string, get TYPE abap_bool, END OF ts_param`
6	TS_SIG_DATA	Public	See coding	20140428	`BEGIN OF ts_sig_data, parameters TYPE tt_sig_param, strip_unknown TYPE abap_bool, END OF ts_sig_data`
7	TS_SIG_PARAM	Public	See coding	20140428	`BEGIN OF ts_sig_param, name TYPE string, value TYPE string, required TYPE abap_bool, regexp TYPE abap_bool, END OF ts_sig_param`
8	TS_TM	Public	See coding	20140428	BEGIN OF ts_tm, object TYPE string, action TYPE string, lpd_id TYPE string, lpd_alias TYPE string, url TYPE string, lang LIKE sy-langu, text TYPE string, text_id TYPE string, application_type TYPE string, additional_data TYPE string, form_factors TYPE ts_form_factor, signature TYPE string, sig_data TYPE ts_sig_data, priority TYPE i, modified TYPE timestamp, target_id TYPE string, mapping_id TYPE string, catalog_id TYPE string, chip_id TYPE string, ref_chip_id TYPE string, client TYPE sy-mandt, config_key TYPE wdy_config_key, END OF ts_tm
9	TS_TM_IDX	Protected	See coding	20140429	`BEGIN OF ts_tm_idx, key TYPE string, client LIKE sy-mandt, tm TYPE REF TO ts_tm, END OF ts_tm_idx`
10	TS_USER_CATALOG	Protected	See coding	20140724	`BEGIN OF ts_user_catalog, user LIKE sy-uname, hash TYPE hash160, catalogs TYPE tt_catalogs, END OF ts_user_catalog`
11	TT_CATALOGS	Public	See coding	20140428	`tt_catalogs TYPE HASHED TABLE OF string WITH UNIQUE KEY table_line INITIAL SIZE 40`
12	TT_PARAMS	Public	See coding	20140428	`tt_params TYPE STANDARD TABLE OF ts_param WITH NON-UNIQUE KEY name`
13	TT_SIG_PARAM	Public	See coding	20140428	`tt_sig_param TYPE STANDARD TABLE OF ts_sig_param WITH KEY name INITIAL SIZE 4`
14	TT_TEXT	Protected	See coding	20140724	`tt_text TYPE HASHED TABLE OF /ui2/if_tm_index_access=>ts_wdy_text_ext WITH UNIQUE KEY config_key text_id lang`
15	TT_TM	Public	See coding	20140428	`tt_tm TYPE SORTED TABLE OF ts_tm WITH NON-UNIQUE KEY object action`
16	TT_TM_CAT_IDX	Protected	See coding	20140428	`tt_tm_cat_idx TYPE SORTED TABLE OF ts_tm_idx WITH NON-UNIQUE KEY KEY`
17	TT_TM_CHIP_IDX	Protected	See coding	20140429	`tt_tm_chip_idx TYPE HASHED TABLE OF ts_tm_idx WITH UNIQUE KEY KEY client`
18	TT_TM_DB	Public	See coding	20140502	`tt_tm_db TYPE SORTED TABLE OF ts_tm WITH NON-UNIQUE KEY client config_key`
19	TT_TM_ID_IDX	Protected	See coding	20140515	`tt_tm_id_idx TYPE HASHED TABLE OF ts_tm_idx WITH UNIQUE KEY KEY`
20	TT_TM_REF	Public	See coding	20140428	`tt_tm_ref TYPE STANDARD TABLE OF REF TO ts_tm`
21	TT_USER_CATALOGS	Protected	See coding	20140724	`tt_user_catalogs TYPE HASHED TABLE OF ts_user_catalog WITH UNIQUE KEY user`

Method Signatures

Method ATTACH_FOR_READ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	HANDLE	Value transfer		Object reference (TYPE REF TO)	/UI2/CL_TM_INDEX_SHA		Shared object area for /UI2/CL_TM_INDEX_SHR class	20140428
2	Importing	INST_NAME	Call by reference		Type reference (TYPE)	SHM_INST_NAME	CL_SHM_AREA=>DEFAULT_INSTANCE	Name of a Shared Object Instance of an Area	20140428

Method ATTACH_FOR_READ on class /UI2/CL_TM_INDEX_SHR has no exception.

Method CHIPID_FROM_TMID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_TM_ID	Call by reference		Type reference (TYPE)	STRING		Target Mapping ID	20140515
2	Returning	RV_CHIP_ID	Value transfer		Type reference (TYPE)	STRING		ChipID	20140515

Method CHIPID_FROM_TMID on class /UI2/CL_TM_INDEX_SHR has no exception.

Method CLASS_CONSTRUCTOR Signature

Method CLASS_CONSTRUCTOR on class /UI2/CL_TM_INDEX_SHR has no parameter.
Method CLASS_CONSTRUCTOR on class /UI2/CL_TM_INDEX_SHR has no exception.

Method FILTER_BY_FORM_FACTOR Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Created on
1	Exporting	EV_MATCH	Call by reference	Type reference (TYPE)	ABAP_BOOL	20140428
2	Importing	IS_FORM_FACTOR	Call by reference	Type reference (TYPE)	TS_FORM_FACTOR	20140428
3	Importing	IS_FORM_FACTOR_EX	Call by reference	Type reference (TYPE)	TS_FORM_FACTOR_EX	20140429
4	Importing	IV_CHECK	Call by reference	Type reference (TYPE)	STRING	20140428
5	Importing	IV_EXCLUDE_SET	Call by reference	Type reference (TYPE)	STRING	20140428

Method FILTER_BY_FORM_FACTOR on class /UI2/CL_TM_INDEX_SHR has no exception.

Method FILTER_BY_SIGNATURE Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Changing	CT_POST_PARAM	Call by reference	Type reference (TYPE)	TIHTTPNVP	Post parameters table to evaluate	20140428
2	Changing	CV_URL	Call by reference	Type reference (TYPE)	STRING	URL with get parameters to evaluate	20140428
3	Exporting	EV_MATCH	Call by reference	Type reference (TYPE)	ABAP_BOOL	Evaluation result	20140428
4	Importing	IS_SIGNATURE	Call by reference	Type reference (TYPE)	TS_SIG_DATA	Signature data (alternative for IV_SIGNATURE)	20140428
5	Importing	IV_SIGNATURE	Call by reference	Type reference (TYPE)	STRING	Signature string (alternative to IS_SIGNATURE)	20140428

Method FILTER_BY_SIGNATURE on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_LAUNCHPAD_DETAILS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Created on
1	Exporting	ES_CONTENT	Call by reference	Type reference (TYPE)	/UI2/IF_FND_LAUNCHPAD_ACCESS=>S_LP_CONTENT	20140505
2	Importing	IT_FILTER_SELECT_OPTIONS	Call by reference	Type reference (TYPE)	/IWBEP/T_MGW_SELECT_OPTION	20140505
3	Importing	IV_ID	Call by reference	Type reference (TYPE)	STRING	20140505

Method GET_LAUNCHPAD_DETAILS on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_MY_CATALOGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_CATALOGS	Call by reference		Type reference (TYPE)	TT_CATALOGS		List of user assigned catalogs	20140428
2	Importing	IV_LOCAL	Call by reference		Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	Extract only local catalogs	20140506

Method GET_MY_CATALOGS on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_MY_TARGETS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_TARGETS	Call by reference	Type reference (TYPE)	TP_T_TARGET	User associated targets	20140429
2	Importing	IT_BUSINESS_PARAMS	Call by reference	Type reference (TYPE)	TIHTTPNVP	Business parameters table	20140429
3	Importing	IV_ACTION	Call by reference	Type reference (TYPE)	/UI2/SEMANTIC_ACTION	Semantic Action	20140429
4	Importing	IV_CHIP_ID	Call by reference	Type reference (TYPE)	STRING	PB chip ID	20140515
5	Importing	IV_FORM_FACTOR	Call by reference	Type reference (TYPE)	STRING	Desired form factor	20140429
6	Importing	IV_OBJECT	Call by reference	Type reference (TYPE)	/UI2/SEMANTIC_OBJECT	Semantic Object	20140429

Method GET_MY_TARGETS on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_MY_TARGET_MAPPINGS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TM	Call by reference		Type reference (TYPE)	TT_TM		Table of Strings	20140428
2	Importing	IV_TM_ID	Call by reference		Type reference (TYPE)	STRING		Target ID	20140430

Method GET_MY_TARGET_MAPPINGS on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_MY_TM_HASH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HASH	Value transfer		Type reference (TYPE)	STRING		Target mapping hash	20140428

Method GET_MY_TM_HASH on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_TARGET_MAPPINGS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Exporting	ET_TM	Call by reference	Type reference (TYPE)	TT_TM	Table of Strings	20140428
2	Importing	IT_BUSINESS_PARAMS	Call by reference	Type reference (TYPE)	TIHTTPNVP	Business parameters table	20140428
3	Importing	IT_CATALOGS	Call by reference	Type reference (TYPE)	TT_CATALOGS	Table of Strings	20140428
4	Importing	IV_ACTION	Call by reference	Type reference (TYPE)	/UI2/SEMANTIC_ACTION	Semantic Action	20140428
5	Importing	IV_FORM_FACTOR	Call by reference	Type reference (TYPE)	STRING	Desired form factor	20140428
6	Importing	IV_OBJECT	Call by reference	Type reference (TYPE)	/UI2/SEMANTIC_OBJECT	Semantic Object	20140428
7	Importing	IV_TM_ID	Call by reference	Type reference (TYPE)	STRING	Target ID	20140430

Method GET_TARGET_MAPPINGS on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_TEXT_FOR_TM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_TM	Call by reference		Type reference (TYPE)	TS_TM		Target Mappings structure	20140724
2	Returning	RV_TEXT	Value transfer		Type reference (TYPE)	STRING		TM title	20140724

Method GET_TEXT_FOR_TM on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_TM_ACCESS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	INSTANCE	Value transfer		Object reference (TYPE REF TO)	/UI2/IF_TM_INDEX_ACCESS		Interface: Target Mapping Index Accessor	20140430

Method GET_TM_ACCESS on class /UI2/CL_TM_INDEX_SHR has no exception.

Method GET_TM_HASH Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_HASH	Value transfer		Type reference (TYPE)	STRING		Target mapping hash	20140428

Method GET_TM_HASH on class /UI2/CL_TM_INDEX_SHR has no exception.

Method INIT Signature

Method INIT on class /UI2/CL_TM_INDEX_SHR has no parameter.
Method INIT on class /UI2/CL_TM_INDEX_SHR has no exception.

Method PARSE_SIGNATURE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SIGNATURE	Call by reference		Type reference (TYPE)	TS_SIG_DATA		Resulting signature data	20140428
2	Importing	IV_SIGNATURE	Call by reference		Type reference (TYPE)	STRING		Signature string to parse	20140428

Method PARSE_SIGNATURE on class /UI2/CL_TM_INDEX_SHR has no exception.

Method PBS_HAS_CHANGED Signature

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

Method PBS_HAS_CHANGED on class /UI2/CL_TM_INDEX_SHR has no exception.

Method PREPARE_PARAMS Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Created on
1	Exporting	ET_PARAMS	Call by reference	Type reference (TYPE)	TT_PARAMS	20140428
2	Exporting	EV_URL	Call by reference	Type reference (TYPE)	STRING	20140428
3	Importing	IT_PARAMS	Call by reference	Type reference (TYPE)	TIHTTPNVP	20140428
4	Importing	IV_URL	Call by reference	Type reference (TYPE)	STRING	20140428

Method PREPARE_PARAMS on class /UI2/CL_TM_INDEX_SHR has no exception.

Method REBUILD_INDEXES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CR_DATA	Call by reference		Object reference (TYPE REF TO)	/UI2/CL_TM_INDEX_SHR		Shared object for target mapping index access	20140505

Method REBUILD_INDEXES on class /UI2/CL_TM_INDEX_SHR has no exception.

Method SELECT_TM_DATA Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Description	Created on
1	Changing	CT_TM_REF	Call by reference	Type reference (TYPE)	TT_TM_REF	Selected TM references	20140429
2	Importing	IR_DATA	Call by reference	Object reference (TYPE REF TO)	/UI2/CL_TM_INDEX_SHR	Reference to TM data	20140429
3	Importing	IT_CATALOGS	Call by reference	Type reference (TYPE)	TT_CATALOGS	Table of Strings	20140429
4	Importing	IV_ACTION	Call by reference	Type reference (TYPE)	/UI2/SEMANTIC_ACTION	Semantic Action	20140429
5	Importing	IV_CHIP_ID	Call by reference	Type reference (TYPE)	STRING	Chip ID	20140429
6	Importing	IV_OBJECT	Call by reference	Type reference (TYPE)	/UI2/SEMANTIC_OBJECT	Semantic Object	20140429
7	Importing	IV_TM_ID	Call by reference	Type reference (TYPE)	STRING	Target Mapping ID	20140515

Method SELECT_TM_DATA on class /UI2/CL_TM_INDEX_SHR has no exception.

Method TRANSFORM Signature

#	Type	Parameter	Pass Value	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_INT_TM	Call by reference	Type reference (TYPE)	/UI2/CL_TM_INDEX_SHR=>TS_TM			20140513
2	Importing	IS_CONFIG_KEY	Call by reference	Type reference (TYPE)	WDY_CONFIG_KEY		Key Components of Configuration Tables	20140513
3	Importing	IS_EXT_TM	Call by reference	Type reference (TYPE)	/UI2/IF_TM_INDEX_ACCESS=>TP_S_TM_INSERT			20140513
4	Importing	IV_CLIENT	Call by reference	Attribute reference (LIKE)	SY-MANDT	SY-MANDT	Client ID of Current User	20140513

Method TRANSFORM on class /UI2/CL_TM_INDEX_SHR has no exception.

History

Last changed by/on	SAP	20141120
SAP Release Created in	100

Object Hierarchy

Using

Used by

Advertise Links