SAP ABAP Class CL_IBO_INBOX_MAPPER (mapper class for inbox component access)

Hierarchy

☛ SAP_BS_FND (Software Component) SAP Business Suite Foundation
   ⤷ CA-EPT-IBO (Application Component) Suite Inbox
     ⤷ IBO_INBOX_UI (Package) Suite Inbox UI

Properties

Class	CL_IBO_INBOX_MAPPER
Short Description	mapper class for inbox component access
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	IBO_INBOX_UI	Suite Inbox UI
Created	20090806	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	IF_WD_PORTAL_INTEGRATION	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

Class CL_IBO_INBOX_MAPPER has no interface implemented.

Friends

Class CL_IBO_INBOX_MAPPER has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_BD_IBO_INBOX_WI_DETAILS	Instance attribute	Private	☐	Object reference (TYPE REF TO)	BD_IBO_INBOX_WI_DETAILS		Reference of the BAdI BD_IBO_INBOX_WI_DETAILS	20091006
2	MO_INBOX_COMPONENT	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IWCI_IBO_WDI_INBOX		Webdynpro interface COMPONENTCONTROLLER	20090807
3	MO_SINGLETON	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_IBO_INBOX_MAPPER		mapper class for inbox component access	20090806
4	MO_SWR_API_FACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWR_API_FACTORY		Factory for Instantiating APIs	20110107
5	MO_VIEW_CONTROLLER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER		Web Dynpro: View Controller	20090806
6	MT_INSTANCES	Static Attribute	Private	☐	Type reference (TYPE)	TT_MAPPER_BY_APPLID			20090819
7	MV_POWL_APPLID	Instance attribute	Private	☐	Type reference (TYPE)	POWL_APPLID_TY		application ID as used in POWL configuration	20090819

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADOPT_DETAILS_AREA_BY_BADI	Instance method	Public	Method	adopt details area by the BAdI BD_IBO_INBOX_WI_DETAILS	20091006
2	CLEAR_DETAILS_AREA	Instance method	Public	Method	Clear Details Area	20090925
3	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20090807
4	FORWARD_ALERT	Instance method	Public	Method	Forward an Alert	20090807
5	FORWARD_NOTIFICATION	Instance method	Public	Method	Forward a Notification	20090807
6	FORWARD_WORK_ITEM	Instance method	Public	Method	Forward currently selected Work Item	20090807
7	GET_INSTANCE	Static method	Public	Method	Get Instance Method	20090807
8	GET_SUBSTITUTE_FILTER	Instance method	Public	Method	Get Filter from substitution toolbar	20090807
9	GET_SUBSTITUTION_API	Instance method	Public	Method	Returns an API instance for Substitutions	20110110
10	GET_SWR_API_FACTORY	Instance method	Private	Method	Ceates an instance of the SWR API factory	20110107
11	GET_TEXT_API	Instance method	Public	Method	Returns an API instance for WF texts	20110110
12	GET_WI_API	Instance method	Public	Method	Returns an API Instance of a given workitem	20110110
13	GET_WORKITEM_DESCRIPTION	Instance method	Public	Method	Returns the item description of a given Workitem	20110110
14	GET_WORKLIST_API	Instance method	Public	Method	Returns an API instance for worklists	20110112
15	IS_API_FACTORY_BOUND	Instance method	Public	Method	Returns abap_true, if WI API is bound	20110125
16	IS_ATTACHMENT_AVAILABLE	Instance method	Public	Method	are Notes available for task type	20100315
17	IS_NOTE_AVAILABLE	Instance method	Public	Method	are Notes available for task type	20100315
18	OPEN_NEW_WINDOW	Instance method	Public	Method	navigate relative to current URL	20090825
19	OPEN_SUBSTITUTION	Instance method	Public	Method	Open the substitution popup	20091204
20	PROCESS_DECISION	Instance method	Public	Method	Show decision dialog of WD component	20091012
21	RESUBMIT_ALERT	Instance method	Public	Method	Resubmit an Alert	20090807
22	RESUBMIT_NOTIFICATION	Instance method	Public	Method	Resubmit a Notification	20090807
23	RESUBMIT_WORK_ITEM	Instance method	Public	Method	Resubmit currently selected Work Item	20090807
24	RUNS_IN_PORTAL	Instance method	Public	Method	returns ABAP_TRUE if the application is run within a portal	20090824
25	SET_DETAILS_AREA	Instance method	Public	Method	Set Details Area based on item data	20090807
26	SET_SELECTED_WORKITEMS	Instance method	Public	Method	Transfer selected workitems from POWL to WD Component	20091014
27	SET_SUBSTITUTE_LIST	Instance method	Public	Method	Set list of users for which this user has substitution items	20090807
28	SET_VIEW_CONTROLLER	Instance method	Public	Method	Set View controller of Inbox component	20090807
29	SET_WDI_CONTROLLER	Instance method	Public	Method	set Webdynpro interface controller	20090819
30	SUBSCRIBE_ALERT	Instance method	Public	Method	Subscribe to Alerts	20090807
31	TRIGGER_POPUP_DETAILS	Instance method	Public	Method		20091203

Events

Class CL_IBO_INBOX_MAPPER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_MAPPER_BY_APPLID	Private	See coding			20090819	BEGIN OF ts_mapper_by_applid, applid type POWL_APPLID_TY, mapper type ref to cl_ibo_inbox_mapper, END OF ts_mapper_by_applid
2	TT_MAPPER_BY_APPLID	Private	See coding			20090819	tt_mapper_by_applid type HASHED TABLE OF ts_mapper_by_applid WITH UNIQUE key applid

Method Signatures

Method ADOPT_DETAILS_AREA_BY_BADI Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONTEXT_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20091006
2	Importing	IS_WORKITEM	Call by reference	☐	Type reference (TYPE)	IBO_INBOX_S_WI		Work Item	20091006

Method ADOPT_DETAILS_AREA_BY_BADI on class CL_IBO_INBOX_MAPPER has no exception.

Method CLEAR_DETAILS_AREA Signature

Method CLEAR_DETAILS_AREA on class CL_IBO_INBOX_MAPPER has no parameter.
Method CLEAR_DETAILS_AREA on class CL_IBO_INBOX_MAPPER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_POWL_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20090819

Method CONSTRUCTOR on class CL_IBO_INBOX_MAPPER has no exception.

Method FORWARD_ALERT Signature

Method FORWARD_ALERT on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method FORWARD_NOTIFICATION Signature

Method FORWARD_NOTIFICATION on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method FORWARD_WORK_ITEM Signature

Method FORWARD_WORK_ITEM on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_INBOX_COMPONENT	Call by reference	☑	Object reference (TYPE REF TO)	IWCI_IBO_WDI_INBOX		WebDynpro Interface INTERFACECONTROLLER	20090819
2	Importing	IV_POWL_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20090819
3	Returning	RO_SINGLETON_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_IBO_INBOX_MAPPER		mapper class for inbox component access	20090807

Method GET_INSTANCE on class CL_IBO_INBOX_MAPPER has no exception.

Method GET_SUBSTITUTE_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_NAME	Call by reference	☐	Type reference (TYPE)	IBO_INBOX_WORKITEM_SUBST		User Substituted by the Current Agent of the Work Item	20090807
2	Exporting	EV_TYPE	Call by reference	☐	Type reference (TYPE)	C			20090807

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method GET_SUBSTITUTION_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_SUBSTITUTION_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWR_SUBSTITUTION_API			20110110

Method GET_SUBSTITUTION_API on class CL_IBO_INBOX_MAPPER has no exception.

Method GET_SWR_API_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_POWL_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20110107
2	Returning	RV_API_FACTORY_BOUND	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		API Factory bound to mapper	20110110

Method GET_SWR_API_FACTORY on class CL_IBO_INBOX_MAPPER has no exception.

Method GET_TEXT_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_TEXT_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWR_TEXT_API		API for Determining Texts	20110110

Method GET_TEXT_API on class CL_IBO_INBOX_MAPPER has no exception.

Method GET_WI_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_WI_KEY	Call by reference	☐	Type reference (TYPE)	SWRSWIKEY		Workflow: Key of Work Item in System	20110110
2	Returning	RO_WORKITEM_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWR_WORKITEM_API		API for Handling a Work Item	20110110

Method GET_WI_API on class CL_IBO_INBOX_MAPPER has no exception.

Method GET_WORKITEM_DESCRIPTION Signature

Method GET_WORKITEM_DESCRIPTION on class CL_IBO_INBOX_MAPPER has no parameter.
Method GET_WORKITEM_DESCRIPTION on class CL_IBO_INBOX_MAPPER has no exception.

Method GET_WORKLIST_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_WORKLIST_API	Value transfer	☐	Object reference (TYPE REF TO)	IF_SWR_WORKLIST_API		API for Determining Worklists	20110112

Method GET_WORKLIST_API on class CL_IBO_INBOX_MAPPER has no exception.

Method IS_API_FACTORY_BOUND Signature

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

Method IS_API_FACTORY_BOUND on class CL_IBO_INBOX_MAPPER has no exception.

Method IS_ATTACHMENT_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_AVAILABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Workflow Task Identifier (Concatenated PD-Org. Type and ID)	20100315
2	Importing	IV_POWL_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20100315
3	Importing	IV_TASK_TYPE	Call by reference	☐	Type reference (TYPE)	IBO_WF_WORKFLOW_TASK_ID		Workflow Task Identifier (Concatenated PD-Org. Type and ID)	20100315
4	Importing	IV_WI_DEST_ID	Call by reference	☑	Type reference (TYPE)	RFC_DEST		Destination of the task	20110118
5	Importing	IV_WI_STATUS	Call by reference	☐	Type reference (TYPE)	SWW_WISTAT		Processing Status of a Work Item	20100315

Method IS_ATTACHMENT_AVAILABLE on class CL_IBO_INBOX_MAPPER has no exception.

Method IS_NOTE_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_IS_AVAILABLE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL		Workflow Task Identifier (Concatenated PD-Org. Type and ID)	20100315
2	Importing	IV_POWL_APPLID	Call by reference	☐	Type reference (TYPE)	POWL_APPLID_TY		Application ID	20100315
3	Importing	IV_TASK_TYPE	Call by reference	☐	Type reference (TYPE)	IBO_WF_WORKFLOW_TASK_ID		Workflow Task Identifier (Concatenated PD-Org. Type and ID)	20100315
4	Importing	IV_WI_DEST_ID	Call by reference	☑	Type reference (TYPE)	RFC_DEST		Destination of the task	20110118
5	Importing	IV_WI_STATUS	Call by reference	☐	Type reference (TYPE)	SWW_WISTAT		Processing Status of a Work Item	20100315

Method IS_NOTE_AVAILABLE on class CL_IBO_INBOX_MAPPER has no exception.

Method OPEN_NEW_WINDOW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BUSINESS_PARAMETERS	Call by reference	☑	Type reference (TYPE)	WDY_KEY_VALUE_LISTGEN		Generic List of Keys/Value Relationships as Strings	20090825
2	Importing	CONTEXT_URL	Call by reference	☑	Type reference (TYPE)	STRING			20090825
3	Importing	HISTORY_MODE	Call by reference	☐	Type reference (TYPE)	STRING	IF_WD_PORTAL_INTEGRATION=>CO_NO_DUPLICATES		20090825
4	Importing	LAUNCHER_PARAMETERS	Call by reference	☑	Type reference (TYPE)	WDY_KEY_VALUE_LISTGEN		Generic List of Keys/Value Relationships as Strings	20090825
5	Importing	NAVIGATION_MODE	Call by reference	☐	Type reference (TYPE)	STRING	IF_WD_PORTAL_INTEGRATION=>CO_SHOW_INPLACE		20090825
6	Importing	POST_PARAMETERS	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20090825
7	Importing	TARGET_TITLE	Call by reference	☑	Type reference (TYPE)	STRING			20090825
8	Importing	USE_SAP_LAUNCHER	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_TRUE		20090825
9	Importing	WDA_NAME	Call by reference	☐	Type reference (TYPE)	STRING		name of WD application	20090825
10	Importing	WINDOW_FEATURES	Call by reference	☑	Type reference (TYPE)	STRING			20090825
11	Importing	WINDOW_NAME	Call by reference	☑	Type reference (TYPE)	STRING			20090825

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090825

Method OPEN_SUBSTITUTION Signature

Method OPEN_SUBSTITUTION on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20091204

Method PROCESS_DECISION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_WORKITEM	Call by reference	☐	Type reference (TYPE)	IBO_S_WF_FACADE_INBOX_WI		Work item ID	20091016
2	Importing	IT_ALTERNATIVES	Call by reference	☐	Type reference (TYPE)	SWRTDECIALTS		User Decision Options (Table Type)	20091012
3	Importing	IV_TITLE	Call by reference	☐	Type reference (TYPE)	WITEXT		Work Item Text	20091012

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20091012

Method RESUBMIT_ALERT Signature

Method RESUBMIT_ALERT on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method RESUBMIT_NOTIFICATION Signature

Method RESUBMIT_NOTIFICATION on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method RESUBMIT_WORK_ITEM Signature

Method RESUBMIT_WORK_ITEM on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method RUNS_IN_PORTAL Signature

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

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090824

Method SET_DETAILS_AREA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IS_ALERT	Call by reference	☑	Type reference (TYPE)	IBO_S_WF_FACADE_INBOX_AL		Alert	20090807
2	Importing	IS_NOTIFICATION	Call by reference	☑	Type reference (TYPE)	IBO_S_WF_FACADE_INBOX_NOT		Notification	20090807
3	Importing	IS_WORKITEM	Call by reference	☑	Type reference (TYPE)	IBO_S_WF_FACADE_INBOX_WI		work item data	20090807

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method SET_SELECTED_WORKITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_RESULT_TAB	Call by reference	☐	Type reference (TYPE)	INDEX TABLE			20091015
2	Importing	IT_SELECTED	Call by reference	☐	Type reference (TYPE)	RSTABIXTAB		Repository Infosystem Table for Indexes	20091015
3	Importing	IV_LEAD_WORKITEM_INDEX	Call by reference	☐	Type reference (TYPE)	SYTABIX		Index of Internal Tables	20091208

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20091014

Method SET_SUBSTITUTE_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SUBSTITUTES	Call by reference	☐	Type reference (TYPE)	STRING_TABLE		Table of Strings	20090807

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method SET_VIEW_CONTROLLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_VIEW_CONTROLLER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_VIEW_CONTROLLER		Web Dynpro: View Controller	20090807

Method SET_VIEW_CONTROLLER on class CL_IBO_INBOX_MAPPER has no exception.

Method SET_WDI_CONTROLLER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_INBOX_COMPONENT	Call by reference	☐	Object reference (TYPE REF TO)	IWCI_IBO_WDI_INBOX		WebDynpro Interface INTERFACECONTROLLER	20090819

Method SET_WDI_CONTROLLER on class CL_IBO_INBOX_MAPPER has no exception.

Method SUBSCRIBE_ALERT Signature

Method SUBSCRIBE_ALERT on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20090819

Method TRIGGER_POPUP_DETAILS Signature

Method TRIGGER_POPUP_DETAILS on class CL_IBO_INBOX_MAPPER has no parameter.

#	Exception	Resumable	Description	Created on
1	CX_IBO_NO_WDI_AVAILABLE	☐	No Webdynpro interface available	20091203

History

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