SAP ABAP Class CL_OAUTH2_CONFIG_UI_ASSISTANCE (Config UI Assistance Class)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SEC (Application Component) Security
     ⤷ SOAUTH2 (Package) OAuth2

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Inheritance (c INHERITING FROM c_ref)	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class	20120320

Properties

Class	CL_OAUTH2_CONFIG_UI_ASSISTANCE
Short Description	Config UI Assistance Class
Super Class	CL_WD_COMPONENT_ASSISTANCE	Basis for a Web Dynpro assistance class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class	SOAUTH2
Program status
Category	0
Package	SOAUTH2	OAuth2
Created	20120320	SAP
Last change	20130531	SAP
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no forward declaration.

Interfaces

Class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no interface implemented.

Friends

Class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MM_MESSAGE_MANAGER	Instance attribute	Public	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER			20120411

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CONFIRMATION_POPUP	Instance method	Public	Method		20120418
2	GET_CLIENT_ID	Instance method	Public	Method		20120321
3	GET_CLIENT_MODE	Instance method	Public	Method		20120321
4	GET_CLIENT_STATE	Instance method	Public	Method		20120417
5	GET_SAML2_URL	Instance method	Public	Method		20120420
6	GET_SCOPE_DESCRIPTION	Instance method	Public	Method		20120327
7	HAS_ERRORS	Instance method	Public	Method		20120521
8	IS_LAST_CLIENT_CHANGED	Instance method	Public	Method		20120419
9	REPORT_EXCEPTIONS	Instance method	Public	Method		20120327
10	SET_ENABLEMENT	Instance method	Public	Method		20120328
11	SET_VISIBILITY	Instance method	Public	Method		20120328
12	UPDATE_CLIENT	Instance method	Public	Method		20120321
13	UPDATE_CONTEXT	Instance method	Public	Method		20120322

Events

Class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no event.

Types

Class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no local type.

Method Signatures

Method CONFIRMATION_POPUP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_COMPONENT_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_COMPONENT			20120418
2	Importing	IR_VIEW_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER			20120418
3	Importing	IV_ACTION_CANCEL	Call by reference	☐	Type reference (TYPE)	STRING			20120418
4	Importing	IV_ACTION_NO	Call by reference	☐	Type reference (TYPE)	STRING			20120418
5	Importing	IV_ACTION_YES	Call by reference	☐	Type reference (TYPE)	STRING			20120418
6	Importing	IV_BUTTON_KIND	Call by reference	☐	Type reference (TYPE)	WDR_POPUP_BUTTON_KIND	IF_WD_WINDOW=>CO_BUTTONS_YESNOCANCEL		20120423

Method CONFIRMATION_POPUP on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method GET_CLIENT_ID Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT			20120321
2	Returning	RV_CLIENT_ID	Value transfer	☐	Type reference (TYPE)	OA2_S_CL_ID			20120321

Method GET_CLIENT_ID on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method GET_CLIENT_MODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT			20120321
2	Returning	RV_MODE	Value transfer	☐	Type reference (TYPE)	CL_OAUTH2_S_CLIENT=>TY_MODE			20120321

Method GET_CLIENT_MODE on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method GET_CLIENT_STATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT			20120417
2	Returning	RV_STATE	Value transfer	☐	Type reference (TYPE)	CHAR01			20120417

Method GET_CLIENT_STATE on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method GET_SAML2_URL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	R_URL	Value transfer	☐	Type reference (TYPE)	STRING			20120420

Method GET_SAML2_URL on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method GET_SCOPE_DESCRIPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_SCOPE_ID	Call by reference	☐	Type reference (TYPE)	OA2_S_SC_ID		OAuth2 Scope ID	20120327
2	Returning	RV_SCOPE_DESCRIPTION	Value transfer	☐	Type reference (TYPE)	OA2_S_SC_DESC		OAuth Scope Description	20120327

Method GET_SCOPE_DESCRIPTION on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method HAS_ERRORS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_MESSAGE_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER			20120521
2	Returning	RV_HAS_ERRORS	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120521

Method HAS_ERRORS on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method IS_LAST_CLIENT_CHANGED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT			20120419
2	Importing	IR_CONTEXT_EL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT			20120419
3	Returning	RV_CHANGED	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120419

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120419

Method REPORT_EXCEPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_EL	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT			20120410
2	Importing	IR_MESSAGE_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message Manager	20120424
3	Importing	IX_OA2	Call by reference	☐	Object reference (TYPE REF TO)	CX_OAUTH2_EXCEPTION			20120327

Method REPORT_EXCEPTIONS on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method SET_ENABLEMENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW			20120328
2	Importing	IV_EL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20120328
3	Importing	IV_ENABLED	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL			20120328

Method SET_ENABLEMENT on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method SET_VISIBILITY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_VIEW	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW			20120328
2	Importing	IV_EL_ID	Call by reference	☐	Type reference (TYPE)	STRING			20120328
3	Importing	IV_VISIBLE	Call by reference	☐	Type reference (TYPE)	WDUI_VISIBILITY			20120328

Method SET_VISIBILITY on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

Method UPDATE_CLIENT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT			20120321
2	Importing	IR_CONTEXT_EL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT			20120321
3	Importing	IV_NO_CLIENT_CHECK	Call by reference	☑	Type reference (TYPE)	BOOLEAN		Boolean Variable (X=True, -=False, Space=Unknown)	20120523

#	Exception	Resumable	Description	Created on
1	CX_OAUTH2_EXCEPTION	☐		20120326

Method UPDATE_CONTEXT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IR_CLIENT	Call by reference	☐	Object reference (TYPE REF TO)	CL_OAUTH2_S_CLIENT			20120322
2	Importing	IR_CONTEXT_EL	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_ELEMENT			20120322

Method UPDATE_CONTEXT on class CL_OAUTH2_CONFIG_UI_ASSISTANCE has no exception.

History

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