SAP ABAP Interface IF_LSAPI (L-Shape API interface)

Hierarchy

☛ SAP_UI (Software Component) User Interface Technology
   ⤷ BC-FES-BUS (Application Component) Netweaver Business Client
     ⤷ SAP_NWBC (Package) NetWeaver Business Client

Properties

Interface	IF_LSAPI
Short Description	L-Shape API interface

General Data

Package	SAP_NWBC	NetWeaver Business Client
Created	20100901	SAP
Last changed	20131127	SAP
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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_LSAPI_DATA_CONTEXT	☐	☐	L-Shape API Data Context interface	20101021

Friends

Interface IF_LSAPI has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_S_PROTOCOL	Constant	Public	☐	See coding				20101209
2	MC_FEATURE_NWBC_NATIVE_SAPGUI	Constant	Public	☐	Type reference (TYPE)	T_FEATURE_TYPE	3	Client support native SAP GUI	20130412
3	MC_FEATURE_NWBC_NAVIGATE	Constant	Public	☐	Type reference (TYPE)	T_FEATURE_TYPE	0	ls-navigate protocolo extension supported	20101011
4	MC_FEATURE_NWBC_NAVIGATE_OBN	Constant	Public	☐	Type reference (TYPE)	T_FEATURE_TYPE	1	ls-obn protocol extension supported	20101021
5	MC_FEATURE_NWBC_TAB_BROWSING	Constant	Public	☐	Type reference (TYPE)	T_FEATURE_TYPE	2	Client supports Tab based browsing	20120730
6	MC_OBN_PARAMETERS	Constant	Public	☐	Type reference (TYPE)	STRING	`obnParameters`		20120309
7	MC_OBN_RESOLVING_MODE	Constant	Public	☐	Type reference (TYPE)	STRING	`resolvingMode`		20120309
8	MC_OBN_RESOLVING_MODE_DEF	Constant	Public	☐	Type reference (TYPE)	STRING	`Default`		20120309
9	MC_OBN_RESOLVING_MODE_SOURCE	Constant	Public	☐	Type reference (TYPE)	STRING	`SourceRole`		20120309
10	MC_TR_FORCE_SAPGUI	Constant	Public	☐	Type reference (TYPE)	STRING	`sap-force_sapgui`		20130412

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	GET_VERSION	Instance method	Public	Method	Return Client Version (Depends on Client Type)	20101011
2	IS_SUPPORTED	Instance method	Public	Method	Check for Function Support	20101011
3	NAVIGATE	Instance method	Public	Method	Navigate to Node in Navigation Tree or to URL	20100901

Events

Interface IF_LSAPI has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	T_FEATURE_TYPE	Public	Type reference (TYPE)	INT1		20111114
2	T_HISTORY_MODE	Public	Type reference (TYPE)	INT1		20111114
3	T_NAVIGATION_MODE	Public	Type reference (TYPE)	INT1		20111114
4	T_PARAMETERS	Public	See coding			20101210	t_parameters TYPE SORTED TABLE OF ihttpnvp WITH UNIQUE KEY name

Method Signatures

Method GET_VERSION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_STRING	Call by reference	☑	Type reference (TYPE)	STRING			20101011
2	Importing	HTTP_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20101011
3	Returning	VERSION	Value transfer	☐	Type reference (TYPE)	STRING		Client version string	20101011

Method GET_VERSION on Interface IF_LSAPI has no exception.

Method IS_SUPPORTED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CONTEXT_STRING	Call by reference	☑	Type reference (TYPE)	STRING			20101011
2	Importing	FEATURE	Call by reference	☐	Type reference (TYPE)	T_FEATURE_TYPE		LSAPI feature type	20101011
3	Importing	HTTP_REQUEST	Call by reference	☑	Object reference (TYPE REF TO)	IF_HTTP_REQUEST		HTTP Framework (iHTTP) HTTP Request	20101011
4	Returning	IS_SUPPORTED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20101011

Method IS_SUPPORTED on Interface IF_LSAPI has no exception.

Method NAVIGATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	HISTORY_MODE	Call by reference	☐	Type reference (TYPE)	T_HISTORY_MODE	1	Defines How Often Navigation Entry Occurs in History	20100901
2	Importing	LOCATION	Call by reference	☐	Type reference (TYPE)	STRING		Location String as Tree Node, URL or SAP GUI Transaction	20100901
3	Importing	MODE	Call by reference	☐	Type reference (TYPE)	T_NAVIGATION_MODE	99	Navigation in Same or External Window	20100901
4	Importing	PARAMETERS	Call by reference	☑	Type reference (TYPE)	T_PARAMETERS		Generic List of Keys/Value Relationships as Strings	20100901
5	Importing	POST_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	TRUE if POST Is to Be Used for Processing; Otherwise GET	20100901
6	Returning	SCRIPT	Value transfer	☐	Type reference (TYPE)	STRING		When Possible, LSAPI Call JavaScript	20100916
7	Importing	TITLE	Call by reference	☑	Type reference (TYPE)	STRING		Title of the New Content Area	20100901
8	Importing	WINDOW_ATTRIBUTES	Call by reference	☑	Type reference (TYPE)	STRING		String Containing a List of Attributes of the New Window	20100901
9	Importing	WINDOW_ID	Call by reference	☑	Type reference (TYPE)	STRING		ID of the Window; Can Be Used to Reuse Existing Windows	20100901
10	Importing	WORK_PROTECT	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE	If true, User Is Asked Before Dirty Session is Left	20100901

#	Exception	Resumable	Description	Created on
1	ERROR	☐	Unclassified error	20100901
2	FEATURE_NOT_SUPPORTED_BY_CLNT	☐	Syntax is not supported by current implementation	20110509

History

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