SAP ABAP Class /IWWRK/CL_WF_USER_INBOX (User inbox handling)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-BSE-WFM (Application Component) Gateway Business Workflow enablement
     ⤷ /IWWRK/WF_RT_IB (Package) Workflow runtime inbound for gateway

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/IWWRK/IF_WF_USER_INBOX	User Inbox Handling	20120613

Properties

Class	/IWWRK/CL_WF_USER_INBOX
Short Description	User inbox handling
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/IWWRK/WF_RT_IB	Workflow runtime inbound for gateway
Created	20120613	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)

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	/IWWRK/IF_WF_USER_INBOX	☐	☐	User Inbox Handling	20120613

Friends

Class /IWWRK/CL_WF_USER_INBOX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MO_WI_READER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	/IWWRK/CL_WF_MGW_GET_WI_DETAIL		Workitem reader class	20120613
2	MS_PAGING	Instance attribute	Private	☐	Type reference (TYPE)	/IWWRK/S_WF_PAGING		paging structure	20120613
3	MT_ORDER	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/T_MGW_SORTING_ORDER		the sorting order	20120613
4	MT_PARENT_WORKLIST	Instance attribute	Private	☐	Type reference (TYPE)	SWRTWIHDR		WAPI: Table Type for Work Item Header	20120613
5	MT_RETURN	Instance attribute	Private	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20120613
6	MT_SELECT_OPTIONS	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/T_MGW_SELECT_OPTION		table of select options	20120613
7	MT_TASKS_CATCH	Instance attribute	Private	☐	Type reference (TYPE)	TT_TASKS_CATCH		tasks catch	20120613
8	MT_TASK_NAME	Instance attribute	Private	☐	Type reference (TYPE)	/IWWRK/T_WF_TASK_NAME		Workflow task table type	20120613
9	MT_WI_DEADLINES	Instance attribute	Private	☐	Type reference (TYPE)	/IWWRK/T_WI_DEADLINES		Workflow item deadlines table	20120613
10	MT_WI_DETAIL	Instance attribute	Private	☐	Type reference (TYPE)	/IWWRK/T_WF_WI_DET		Workitem details tab	20120613
11	MT_WORKLIST	Instance attribute	Private	☐	Type reference (TYPE)	SWRTWIHDR		WAPI: Table Type for Work Item Header	20120613
12	MV_FILTER_ACTIVE	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL		Is filter active	20120613
13	MV_HEADER_FILTER	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20120613
14	MV_HEADER_ORDER	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20120613
15	MV_LANGU	Instance attribute	Private	☐	Type reference (TYPE)	SY-LANGU		Language key	20120613
16	MV_OPTIMIZE_QUERY	Instance attribute	Private	☐	Type reference (TYPE)	ABAP_BOOL			20120613
17	MV_TASK_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	/IWWRK/WF_TASK_TYPE		Task type	20120613
18	MV_USER	Instance attribute	Private	☐	Type reference (TYPE)	SY-UNAME		User Name	20120613

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	APPEND_MSG_TO_RETTAB	Instance method	Protected	Method	Append messages to bapi return tab	20120613
2	APPEND_PARENT_HEADER	Instance method	Protected	Method	Append the workitem parent header	20120613
3	APPEND_TASK_ATT_ERROR	Instance method	Protected	Method	Append message on task attribute error	20120613
4	APPEND_TASK_NAME	Instance method	Protected	Method	Append line to task name table	20120613
5	APPEND_WI_DEADLINES	Instance method	Protected	Method	Append the workflow item deadlines	20120613
6	APPEND_WI_DETAIL	Instance method	Protected	Method	Append line to workitem detail table	20120613
7	COMPLETE_WORKLIST_DATA	Instance method	Protected	Method		20120613
8	FILTER_ITEM_BY_CONFIG	Instance method	Protected	Method	Filter the item according to the requested type	20120613
9	GET_STATUS_LIST	Instance method	Protected	Method	Get Status list filter provided by the user / application	20120911
10	GET_TASK_FROM_WF_STEP	Instance method	Protected	Method	Get task_id from wf id and step id	20120911
11	IS_USER_DECISION_TASK	Instance method	Protected	Method	Check if the task is a user decision task	20120613
12	OPTIMIZE_QUERY_STRING_OPTIONS	Instance method	Protected	Method	optimistic apply query string option if only header fields	20120613
13	SET_FILTER_TASKS	Instance method	Protected	Method	Set technical task id from customizable display name	20120910
14	SET_WI_READER	Instance method	Protected	Method	Set workitem reader	20120613
15	SET_WORKLIST	Instance method	Protected	Method	Set the user inbox worklist	20120613

Events

Class /IWWRK/CL_WF_USER_INBOX has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TS_TASKS_CATCH	Private	See coding			20120613	BEGIN OF ts_tasks_catch, task TYPE sww_task, user_decision TYPE flag, END OF ts_tasks_catch
2	TT_TASKS_CATCH	Private	See coding			20120613	tt_tasks_catch TYPE STANDARD TABLE OF ts_tasks_catch
3	TT_WORKLIST	Public	See coding			20120613	tt_worklist TYPE STANDARD TABLE OF swr_wihdr WITH DEFAULT KEY

Method Signatures

Method APPEND_MSG_TO_RETTAB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_MSG_LINES	Call by reference	☐	Type reference (TYPE)	SAPI_MSG_LINES		Table with sap wapi Message (Lines)	20120613

Method APPEND_MSG_TO_RETTAB on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method APPEND_PARENT_HEADER Signature

Method APPEND_PARENT_HEADER on class /IWWRK/CL_WF_USER_INBOX has no parameter.
Method APPEND_PARENT_HEADER on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method APPEND_TASK_ATT_ERROR Signature

Method APPEND_TASK_ATT_ERROR on class /IWWRK/CL_WF_USER_INBOX has no parameter.
Method APPEND_TASK_ATT_ERROR on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method APPEND_TASK_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_STEP_ID		Workflow Step ID	20120613
2	Importing	IV_WORKFLOW_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_ID		Workflow ID	20120613
3	Importing	IV_WORKITEM_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20120613

Method APPEND_TASK_NAME on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method APPEND_WI_DEADLINES Signature

Method APPEND_WI_DEADLINES on class /IWWRK/CL_WF_USER_INBOX has no parameter.
Method APPEND_WI_DEADLINES on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method APPEND_WI_DETAIL Signature

Method APPEND_WI_DETAIL on class /IWWRK/CL_WF_USER_INBOX has no parameter.
Method APPEND_WI_DETAIL on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method COMPLETE_WORKLIST_DATA Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WITH_DEADLINES	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120613
2	Importing	IV_WITH_PARENT_WORKLIST	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120613
3	Importing	IV_WITH_TASK_NAME	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120613
4	Importing	IV_WITH_WI_DETAIL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE		20120613
5	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Return Value of ABAP Statements	20120613

Method COMPLETE_WORKLIST_DATA on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method FILTER_ITEM_BY_CONFIG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_ITEM_DELETED	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20120613
2	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Return Value of ABAP Statements	20120613
3	Importing	IV_TASK	Call by reference	☐	Type reference (TYPE)	SWW_TASK		Task ID	20120613
4	Importing	IV_WF_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_ID		Workflow ID	20120613
5	Importing	IV_WF_STEP_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_STEP_ID		Workflow step ID	20120613

Method FILTER_ITEM_BY_CONFIG on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method GET_STATUS_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_STATUS_EQ	Call by reference	☐	Type reference (TYPE)	SWRTSTATUS		WAPI: Table Type for Status	20120911
2	Importing	IV_TASK_PROPERY_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'status'	Name of status property in service	20120911

Method GET_STATUS_LIST on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method GET_TASK_FROM_WF_STEP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_STEP_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_STEP_ID		Workflow Step ID	20120911
2	Importing	IV_WFID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_ID		Workflow ID	20120911
3	Returning	RV_TASK_ID	Value transfer	☐	Type reference (TYPE)	STRING			20120911

Method GET_TASK_FROM_WF_STEP on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method IS_USER_DECISION_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EV_RETURN_CODE	Call by reference	☐	Type reference (TYPE)	SY-SUBRC		Return Value of ABAP Statements	20120613
2	Exporting	EV_UD_TASK	Call by reference	☐	Type reference (TYPE)	FLAG		General Flag	20120613
3	Importing	IV_TASK	Call by reference	☐	Type reference (TYPE)	SWW_TASK		Task ID	20120613

Method IS_USER_DECISION_TASK on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method OPTIMIZE_QUERY_STRING_OPTIONS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_WORKLIST	Call by reference	☐	Type reference (TYPE)	SWRTWIHDR		WAPI: Table Type for Work Item Header	20120613

Method OPTIMIZE_QUERY_STRING_OPTIONS on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method SET_FILTER_TASKS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TASK_FILTER_EQ	Call by reference	☐	Type reference (TYPE)	SWRTTASK		WAPI: Table Type for Tasks	20120911
2	Importing	IV_TASK_PROPERY_NAME	Call by reference	☐	Type reference (TYPE)	STRING	'task_name'	the property name to filter by	20120911

Method SET_FILTER_TASKS on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method SET_WI_READER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_WORKITEM_ID	Call by reference	☐	Type reference (TYPE)	SWW_WIID		Work item ID	20120613

Method SET_WI_READER on class /IWWRK/CL_WF_USER_INBOX has no exception.

Method SET_WORKLIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RETURN_CODE	Value transfer	☐	Type reference (TYPE)	SY-SUBRC		Return Value of ABAP Statements	20120613

Method SET_WORKLIST on class /IWWRK/CL_WF_USER_INBOX has no exception.

History

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