SAP ABAP Class CL_FDT_SFW (Switch Framework related functionality)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
     ⤷ SFDT_CORE (Package) BRFplus: Core

Properties

Class	CL_FDT_SFW
Short Description	Switch Framework related functionality
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SFDT_CORE	BRFplus: Core
Created	20110913	SAP
Last change	20130531	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_FDT_SFW_SERVICES	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	CL_FDT_TYPEDESCR	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
4	IF_FDT_DATA_OBJECT	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...
5	IF_FDT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_FDT_SFW has no interface implemented.

Friends

#	Friend	Modeled only	Created on	Description
1	CL_FDT_GTC_SFW	☐	20111208	BRFplus unit tests for Switch Framework (SFW)

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_SWITCH_STATE_ERROR	Constant	Public	☐	Type reference (TYPE)	SFW_SWITCHPOS	'E'	error	20111207
2	GC_SWITCH_STATE_NONE	Constant	Public	☐	Type reference (TYPE)	SFW_SWITCHPOS	''	no switch	20111207
3	GC_SWITCH_STATE_OFF	Constant	Public	☐	Type reference (TYPE)	SFW_SWITCHPOS	'F'	off	20111207
4	GC_SWITCH_STATE_ON	Constant	Public	☐	Type reference (TYPE)	SFW_SWITCHPOS	'T'	on	20111207
5	GC_SWITCH_STATE_STANDBY	Constant	Public	☐	Type reference (TYPE)	SFW_SWITCHPOS	'S'	stand-by	20111207
6	GTH_OBJECT_INFO_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	TH_OBJECT_INFO_BUFFER		Object info buffer	20110919
7	GTH_SWITCH_INFO_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	TH_SWITCH_INFO_BUFFER		Switch info buffer	20110919
8	GTS_CONN_BUFFER	Static Attribute	Private	☐	Type reference (TYPE)	CL_FDT_TYPEDESCR=>TS_CONN_BUFFER		Connection buffer	20120529
9	GT_OBJECT_PREFETCH_REQUEST	Static Attribute	Private	☐	Type reference (TYPE)	T_OBJECT_PREFETCH_REQUEST		Collect object info requests	20111202
10	GT_SWITCH_PREFETCH_REQUEST	Static Attribute	Private	☐	Type reference (TYPE)	T_SWITCH_PREFETCH_REQUEST		Collect switch info requests	20111202

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_OBJECT_PREFETCH_REQUEST	Static method	Private	Method		20111202
2	ADD_SWITCH_PREFETCH_REQUEST	Static method	Private	Method		20111202
3	CLEAR_BUFFERS	Static method	Public	Method	Clear all buffered data	20110921
4	GET_OBJECT_INFO_BUF	Static method	Private	Method	Get switch information from buffer	20111202
5	GET_RFC_DESTINATION	Static method	Private	Method		20110919
6	GET_SWITCH_INFO	Static method	Public	Method	Get info about a specific switch	20111125
7	GET_SWITCH_INFO_BUF	Static method	Private	Method	Get switch information from buffer	20110922
8	GET_SWITCH_INFO_FOR_DDIC_TYPE	Static method	Public	Method	Get actual switch info	20111201
9	GET_SWITCH_INFO_FOR_DOBJ	Static method	Public	Method	Get actual switch info	20111125
10	GET_SWITCH_INFO_FOR_OBJECT	Static method	Protected	Method	Get actual switch info	20110919
11	PREFETCH_OBJECT_INFO	Static method	Protected	Method	Register a request for switch info	20111202
12	PREFETCH_SWITCH_INFO	Static method	Public	Method	Register a request for switch info	20111202
13	SET_OBJECT_INFO_BUF	Static method	Private	Method	Retrieve switch info for pending list of objects	20111202
14	SET_SWITCH_INFO_BUF	Static method	Private	Method		20111202
15	UPDATE_OBJECT_INFO_BUF	Static method	Private	Method	Retrieve switch info for pending list of objects	20111202
16	UPDATE_SWITCH_INFO_BUF	Static method	Private	Method	Retrieve switch info for pending list of objects	20110922

Events

Class CL_FDT_SFW has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_OBJECT_INFO_BUFFER	Private	See coding			20111201	BEGIN OF s_object_info_buffer, rfc_destination TYPE rfcdest, object_type TYPE sfw_switchposition-objecttype, object_name TYPE sfw_switchposition-objectname, switch_id TYPE sfw_switchposition-switch_id, END OF s_object_info_buffer
2	S_OBJECT_PREFETCH_REQUEST	Private	See coding			20111202	BEGIN OF s_object_prefetch_request, rfc_destination TYPE rfcdest, object_type TYPE cl_fdt_sfw_services=>s_object_switch_info-object_type, object_name TYPE cl_fdt_sfw_services=>s_object_switch_info-object_name, END OF s_object_prefetch_request
3	S_SWITCH_INFO	Public	See coding			20111201	BEGIN OF s_switch_info, id TYPE fdt_s_sfw_switch_info-switch_id, state TYPE fdt_s_sfw_switch_info-switch_state, text TYPE fdt_s_sfw_switch_info-switch_text, END OF s_switch_info
4	S_SWITCH_INFO_BUFFER	Private	See coding			20111201	BEGIN OF s_switch_info_buffer, rfc_destination TYPE rfcdest. INCLUDE TYPE s_switch_info. TYPES: END OF s_switch_info_buffer
5	S_SWITCH_PREFETCH_REQUEST	Private	See coding			20111202	BEGIN OF s_switch_prefetch_request, rfc_destination TYPE rfcdest, switch_id TYPE sfw_switch_id, END OF s_switch_prefetch_request
6	TH_OBJECT_INFO_BUFFER	Private	See coding			20111201	th_object_info_buffer TYPE HASHED TABLE OF s_object_info_buffer WITH UNIQUE KEY rfc_destination object_type object_name
7	TH_SWITCH_INFO_BUFFER	Private	See coding			20111201	th_switch_info_buffer TYPE HASHED TABLE OF s_switch_info_buffer WITH UNIQUE KEY rfc_destination id
8	T_OBJECT_PREFETCH_REQUEST	Private	See coding			20111202	t_object_prefetch_request TYPE STANDARD TABLE OF s_object_prefetch_request WITH NON-UNIQUE SORTED KEY rfc_dest COMPONENTS rfc_destination
9	T_SWITCH_PREFETCH_REQUEST	Private	See coding			20111202	t_switch_prefetch_request TYPE STANDARD TABLE OF s_switch_prefetch_request WITH NON-UNIQUE SORTED KEY rfc_dest COMPONENTS rfc_destination

Method Signatures

Method ADD_OBJECT_PREFETCH_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	CL_FDT_SFW_SERVICES=>S_OBJECT_SWITCH_INFO-OBJECT_NAME		Object Name in Object Directory	20111202
2	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	CL_FDT_SFW_SERVICES=>S_OBJECT_SWITCH_INFO-OBJECT_TYPE		Object Type	20111202
3	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20111202

Method ADD_OBJECT_PREFETCH_REQUEST on class CL_FDT_SFW has no exception.

Method ADD_SWITCH_PREFETCH_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20111202
2	Importing	IV_SWITCH_ID	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-ID			20111202

Method ADD_SWITCH_PREFETCH_REQUEST on class CL_FDT_SFW has no exception.

Method CLEAR_BUFFERS Signature

Method CLEAR_BUFFERS on class CL_FDT_SFW has no parameter.
Method CLEAR_BUFFERS on class CL_FDT_SFW has no exception.

Method GET_OBJECT_INFO_BUF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SWITCH_INFO	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO		Short Text for Switch	20111202
2	Exporting	EV_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		TRUE: No entry found in buffer	20111202
3	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	S_OBJECT_INFO_BUFFER-OBJECT_NAME		Object Name in Object Directory	20111202
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	S_OBJECT_INFO_BUFFER-OBJECT_TYPE		Object Type	20111202
5	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20111202

Method GET_OBJECT_INFO_BUF on class CL_FDT_SFW has no exception.

Method GET_RFC_DESTINATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		Universal Unique Identifier	20110919
2	Returning	RV_RFC_DESTINATION	Value transfer	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20110919

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20110919

Method GET_SWITCH_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_SWITCH_STATE	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-STATE		Switch Position	20111125
2	Exporting	EV_SWITCH_TEXT	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-TEXT		Short Text for Switch	20111125
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		ID to retrieve RFC destination	20111125
4	Importing	IV_SWITCH_ID	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-ID		Id of a Switch in Switch Framework	20111125

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20121121

Method GET_SWITCH_INFO_BUF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NOT_FOUND	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		TRUE: No entry found in buffer	20110922
2	Exporting	EV_SWITCH_STATE	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-STATE		Switch Position	20110922
3	Exporting	EV_SWITCH_TEXT	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-TEXT		Short Text for Switch	20110922
4	Importing	IV_RFC_DESTINATION	Call by reference	☑	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20110922
5	Importing	IV_SWITCH_ID	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-ID		Id of a Switch in Switch Framework	20110922

Method GET_SWITCH_INFO_BUF on class CL_FDT_SFW has no exception.

Method GET_SWITCH_INFO_FOR_DDIC_TYPE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SWITCH_INFO	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO			20111201
2	Importing	IV_DATA_OBJECT_TYPE	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>DATA_OBJECT_TYPE		Data Object Type	20111201
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		ID to retrieve RFC destination	20111201
4	Importing	IV_TYPENAME	Call by reference	☐	Type reference (TYPE)	IF_FDT_DATA_OBJECT=>TYPENAME		DDIC typename	20111201

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20121121

Method GET_SWITCH_INFO_FOR_DOBJ Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SWITCH_INFO	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO		Id of a Switch in Switch Framework	20111201
2	Importing	IO_DATA_OBJECT	Call by reference	☑	Object reference (TYPE REF TO)	IF_FDT_DATA_OBJECT		FDT: Data Object	20111201
3	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>ID		Universal Unique Identifier	20111201
4	Importing	IV_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP		Time Stamp (active version, UTC)	20111201

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Abstract Exception Class	20111201

Method GET_SWITCH_INFO_FOR_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ES_SWITCH_INFO	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO			20111201
2	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>ID		ID to retrieve RFC destination	20110919
3	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	CL_FDT_SFW_SERVICES=>S_OBJECT_SWITCH_INFO-OBJECT_NAME		Object Name in Object Directory	20110919
4	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	CL_FDT_SFW_SERVICES=>S_OBJECT_SWITCH_INFO-OBJECT_TYPE		Object Type	20110919

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20121121

Method PREFETCH_OBJECT_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>ID		ID to get RFC destination	20111202
2	Importing	IV_OBJECT_NAME	Call by reference	☐	Type reference (TYPE)	FDT_S_SFW_OBJECT_INFO-OBJECT_NAME		Object Name in Object Directory	20111202
3	Importing	IV_OBJECT_TYPE	Call by reference	☐	Type reference (TYPE)	FDT_S_SFW_OBJECT_INFO-OBJECT_TYPE		Object Type	20111202

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20121121

Method PREFETCH_SWITCH_INFO Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		ID to get RFC destination	20111202
2	Importing	IV_SWITCH_ID	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-ID		Id of a Switch in Switch Framework	20111202

#	Exception	Resumable	Description	Created on
1	CX_FDT_INPUT	☐	FDT: Invalid Input	20121121

Method SET_OBJECT_INFO_BUF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_OBJECT_SWITCH_INFO	Call by reference	☐	Type reference (TYPE)	CL_FDT_SFW_SERVICES=>S_OBJECT_SWITCH_INFO			20111202
2	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20111202

Method SET_OBJECT_INFO_BUF on class CL_FDT_SFW has no exception.

Method SET_SWITCH_INFO_BUF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20111202
2	Importing	IV_SWITCH_ID	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-ID		Switch ID	20111202
3	Importing	IV_SWITCH_STATE	Call by reference	☐	Type reference (TYPE)	S_SWITCH_INFO-STATE		Switch state	20111202
4	Importing	IV_SWITCH_TEXT	Call by reference	☑	Type reference (TYPE)	S_SWITCH_INFO-TEXT		Switch text	20111202

Method SET_SWITCH_INFO_BUF on class CL_FDT_SFW has no exception.

Method UPDATE_OBJECT_INFO_BUF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20111202

Method UPDATE_OBJECT_INFO_BUF on class CL_FDT_SFW has no exception.

Method UPDATE_SWITCH_INFO_BUF Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_RFC_DESTINATION	Call by reference	☐	Type reference (TYPE)	RFCDEST		Logical Destination (Specified in Function Call)	20110922

Method UPDATE_SWITCH_INFO_BUF on class CL_FDT_SFW has no exception.

History

Last changed by/on	SAP	20130531
SAP Release Created in	732