SAP ABAP Class /IWWRK/CL_TGW_GEN_INBOX (Impl. of task inbox - engine api)

Hierarchy

☛ SAP_GWFND (Software Component) SAP Gateway Foundation
   ⤷ OPU-BSE-WFM (Application Component) Gateway Business Workflow enablement
     ⤷ /IWWRK/WF_ODC_INBOX (Package) Workflow ODC Runtime for Gateway - Generic Inbox

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	/IWWRK/IF_WF_TGW_USER_INBOX	User Inbox handling for Task Gateway	20121112

Properties

Class	/IWWRK/CL_TGW_GEN_INBOX
Short Description	Impl. of task inbox - engine api
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	/IWWRK/WF_ODC_INBOX	Workflow ODC Runtime for Gateway - Generic Inbox
Created	20121108	SAP
Last change	20131127	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_TGW_USER_INBOX	☐	☐	User Inbox handling for Task Gateway	20121112

Friends

Class /IWWRK/CL_TGW_GEN_INBOX has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GCS_UI_MAPPING	Constant	Public	☐	See coding				20121112
2	GCS_WAPI_INBOX_TYPE	Constant	Public	☐	See coding				20121112
3	GCS_WAPI_MOBILE_INBOX_METHOD	Constant	Public	☐	See coding				20121112
4	GC_FILTER_DEADLINE_FIELDS	Constant	Public	☐	Type reference (TYPE)	STRING	'STARTDEADLINE,COMPLETIONDEADLINE,EXPIRYDATE'		20121112
5	GC_FILTER_OTHER_HANDLING	Constant	Public	☐	Type reference (TYPE)	STRING	'HasAttachments,HasPotentialOwners,HasComments,IsEscalated,TaskTitle'		20121112
6	GC_FILTER_RANGE_DATE_HANDLING	Constant	Public	☐	Type reference (TYPE)	STRING	'CreatedOn,StartDeadLine,CompletionDeadLine,ExpiryDate'		20121112
7	GC_FILTER_TASK_HANDLING	Constant	Public	☐	Type reference (TYPE)	STRING	''		20121112
8	GC_PROP_ENGINE_WITH_ADDITIONS	Constant	Public	☐	Type reference (TYPE)	STRING	'InstanceID,TaskDefinitionID,TaskDefinitionName,TaskTitle,Priority,Status,CreatedOn,CreatedBy,Processor,StartDeadLine,CompletionDead		20130217
9	GC_SORTING_OTHER_HANDLING	Constant	Public	☐	Type reference (TYPE)	STRING	'InstanceID,TaskDefinitionID,TaskTitle,Priority,Status,CreatedBy,Processor,IsEscalated,HasComments,HasPotentialOwners'		20130214
10	GC_WAPI_INBOX_CL	Constant	Public	☐	Type reference (TYPE)	SEOCLSNAME	'CL_WAPI_MOBILE_INBOX'		20121112
11	MO_WAPI_MOBILE_INST_OBJ	Instance attribute	Protected	☐	Object reference (TYPE REF TO)	OBJECT			20121112
12	MS_PAGING	Instance attribute	Private	☐	Type reference (TYPE)	/IWWRK/S_WF_PAGING		paging structure	20121112
13	MT_ORDER	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/T_MGW_SORTING_ORDER		the sorting order	20121112
14	MT_SELECT_OPTIONS	Instance attribute	Private	☐	Type reference (TYPE)	/IWBEP/T_MGW_SELECT_OPTION		table of select options	20121112
15	MV_HEADER_FILTER	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20121112
16	MV_HEADER_ORDER	Instance attribute	Private	☐	Type reference (TYPE)	STRING			20121112
17	MV_TASK_TYPE	Instance attribute	Private	☐	Type reference (TYPE)	/IWWRK/WF_TASK_TYPE		Task type	20121112

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	CALCULATE_QUERY_STRING_OPTION	Instance method	Protected	Method	Calculate filter paging sorting	20121112
2	CREATE_SET_COMPLEX_FILTER	Instance method	Protected	Method		20121113
3	CREATE_SET_FILTER	Instance method	Protected	Method		20121112
4	CREATE_SET_FILTER_BY_TASK_NAME	Instance method	Protected	Method	Set filter by task name	20121202
5	CREATE_SET_RANGE_FILTER	Instance method	Protected	Method		20121210
6	FILTER_TASK_ATT	Instance method	Protected	Method		20121112
7	GET_BAPIRET_FROM_BUSI_EXP	Instance method	Private	Method		20121127
8	GET_INBOX	Instance method	Protected	Method	Get item from inbox	20121112
9	GET_TASK_MIME_TYPE	Instance method	Private	Method	Get task icon mime type	20130411
10	GET_TASK_NAME	Instance method	Protected	Method	Get the task type name	20121112
11	IS_INBOX_RELEVANT	Instance method	Private	Method	is inbox relevant	20121206
12	IS_OUTBOX_RELAVANT	Instance method	Private	Method	Check if outbox is relevant for extraction	20121206
13	MAP_WAPI_TO_TASK	Instance method	Protected	Method	Map WAPI structure to task structure	20121112
14	OPTIMIZE_QUERY_STR_OPTION	Instance method	Private	Method	Optimize the query string options	20130214
15	SET_WAPI_INSTANCE	Instance method	Protected	Method		20121112
16	UPDATE_STATUS_SELECT_OPTION	Instance method	Private	Method	is inbox relevant	20130528

Events

Class /IWWRK/CL_TGW_GEN_INBOX has no event.

Types

Class /IWWRK/CL_TGW_GEN_INBOX has no local type.

Method Signatures

Method CALCULATE_QUERY_STRING_OPTION Signature

Method CALCULATE_QUERY_STRING_OPTION on class /IWWRK/CL_TGW_GEN_INBOX has no parameter.

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20121127

Method CREATE_SET_COMPLEX_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_COMP_NAME	Call by reference	☐	Type reference (TYPE)	STRING			20121113
2	Importing	IV_FILTER_TABLE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20121113
3	Importing	IV_PROPERTY	Call by reference	☐	Type reference (TYPE)	STRING			20121113
4	Importing	IV_WAPI_INBOX_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	SEOCPDNAME		Full Component Name	20121113

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20121127

Method CREATE_SET_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_SINGLE_VALUE	Call by reference	☐	Type reference (TYPE)	ANY			20121112
2	Importing	IV_FILTER_TABLE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20121112
3	Importing	IV_PROPERTY	Call by reference	☐	Type reference (TYPE)	STRING			20121112
4	Importing	IV_WAPI_INBOX_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	SEOCPDNAME		Full Component Name	20121112

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20121127

Method CREATE_SET_FILTER_BY_TASK_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_FILTER_TABLE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20121203
2	Importing	IV_PROPERTY	Call by reference	☐	Type reference (TYPE)	STRING			20121203
3	Importing	IV_WAPI_INBOX_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	SEOCPDNAME		Full Component Name	20121203

Method CREATE_SET_FILTER_BY_TASK_NAME on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method CREATE_SET_RANGE_FILTER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CV_SINGLE_VALUE	Call by reference	☐	Type reference (TYPE)	ANY			20121210
2	Importing	IV_FILTER_TABLE_TYPE	Call by reference	☐	Type reference (TYPE)	STRING			20121210
3	Importing	IV_PROPERTY	Call by reference	☐	Type reference (TYPE)	STRING			20121210
4	Importing	IV_WAPI_INBOX_METHOD_NAME	Call by reference	☐	Type reference (TYPE)	SEOCPDNAME		Full Component Name	20121210

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20121210

Method FILTER_TASK_ATT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TASKS	Call by reference	☐	Type reference (TYPE)	/IWWRK/T_TGW_TASK		Task Gateway: Task Headers	20130124

Method FILTER_TASK_ATT on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method GET_BAPIRET_FROM_BUSI_EXP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20121127
2	Importing	IX_BUSI_EXCEPTION	Call by reference	☐	Object reference (TYPE REF TO)	/IWBEP/CX_MGW_BUSI_EXCEPTION		Business Exception	20121127

Method GET_BAPIRET_FROM_BUSI_EXP on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method GET_INBOX Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_TASKS	Call by reference	☐	Type reference (TYPE)	/IWWRK/T_TGW_TASK		Task Gateway: Task Headers	20121112
2	Exporting	ET_USERS	Call by reference	☐	Type reference (TYPE)	/IWWRK/T_WF_TASK_AGENTS		Workflow task agents table	20121113

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20121127

Method GET_TASK_MIME_TYPE 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	20130411
2	Importing	IV_WF_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_ID		Workflow ID	20130411
3	Returning	RV_MIME_TYPE	Value transfer	☐	Type reference (TYPE)	SAEMIME		MIME Type	20130411

Method GET_TASK_MIME_TYPE on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method GET_TASK_NAME Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_RETURN	Call by reference	☐	Type reference (TYPE)	BAPIRETTAB		Table with BAPI Return Information	20121112
2	Exporting	EV_WF_STEP_TEXT	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_GP_BOUNDITEM_TYPE		Workflow Step Description	20121112
3	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU	SY-LANGU	Language Key of Current Text Environment	20121112
4	Importing	IV_WF_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_ID		Workflow ID	20121112
5	Importing	IV_WF_STEP_ID	Call by reference	☐	Type reference (TYPE)	/IWWRK/WF_STEP_ID		Workflow Step ID	20121112

Method GET_TASK_NAME on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method IS_INBOX_RELEVANT Signature

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

Method IS_INBOX_RELEVANT on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method IS_OUTBOX_RELAVANT Signature

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

Method IS_OUTBOX_RELAVANT on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method MAP_WAPI_TO_TASK Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_WORKITEM_USERS	Call by reference	☐	Type reference (TYPE)	/IWWRK/T_WF_TASK_AGENTS		Structure for workflow task agents	20121113
2	Exporting	ES_WORKITEM_TASK	Call by reference	☐	Type reference (TYPE)	/IWWRK/S_TGW_TASK		Task Gateway: Task Header	20121113
3	Importing	IS_WORKITEM_REF	Call by reference	☐	Type reference (TYPE)	ANY			20121112

Method MAP_WAPI_TO_TASK on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method OPTIMIZE_QUERY_STR_OPTION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	CT_TABLE	Call by reference	☐	Type reference (TYPE)	/IWWRK/T_TGW_TASK		Task Gateway: Task Headers	20130214

Method OPTIMIZE_QUERY_STR_OPTION on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

Method SET_WAPI_INSTANCE Signature

Method SET_WAPI_INSTANCE on class /IWWRK/CL_TGW_GEN_INBOX has no parameter.

#	Exception	Resumable	Description	Created on
1	/IWBEP/CX_MGW_BUSI_EXCEPTION	☐	Business Exception	20121127

Method UPDATE_STATUS_SELECT_OPTION Signature

Method UPDATE_STATUS_SELECT_OPTION on class /IWWRK/CL_TGW_GEN_INBOX has no parameter.
Method UPDATE_STATUS_SELECT_OPTION on class /IWWRK/CL_TGW_GEN_INBOX has no exception.

History

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