SAP ABAP Class CL_SWN_WI_AGENTS (Workflow: Ascertains Inbox Users)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-BMT-WFM (Application Component) SAP Business Workflow
     ⤷ SWN (Package) Business Workflow: E-Mail Notifications for Work Items

Properties

Class	CL_SWN_WI_AGENTS
Short Description	Workflow: Ascertains Inbox Users
Super Class
Instantiability of a Class	0	Private
Final	☑

General Data

Message Class
Program status
Category	0
Package	SWN	Business Workflow: E-Mail Notifications for Work Items
Created	20131119	SAP
Last change	20141121
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CL_SWN_WI_AGENTS has no forward declaration.

Interfaces

Class CL_SWN_WI_AGENTS has no interface implemented.

Friends

Class CL_SWN_WI_AGENTS has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	M_AGENTS	Instance attribute	Private	☐	Type reference (TYPE)	LOCAL_WI_AGENT_TAB			20131125
2	M_CRT_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL			20131125
3	M_FREE_TIMESTAMP	Instance attribute	Private	☐	Type reference (TYPE)	TIMESTAMPL			20131125
4	M_LAST_MESSAGE_STRUCT	Instance attribute	Private	☐	Type reference (TYPE)	SWRTMSTRUC			20131125
5	M_LAST_RETURN_CODE	Instance attribute	Private	☐	Type reference (TYPE)	SYTABIX			20131125
6	M_RFCDEST	Instance attribute	Private	☐	Object reference (TYPE REF TO)	RFCDEST			20131125
7	M_SINGLETON_WITHOUT_SUBST	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWN_WI_AGENTS			20131125
8	M_SINGLETON_WITH_SUBSTITUTE	Static Attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWN_WI_AGENTS			20131125
9	M_WAPI_CALL_HISTORY	Instance attribute	Private	☐	Type reference (TYPE)	LOCAL_CALL_HISTORY_TAB			20131125
10	M_WITH_SUBSTITUTES	Instance attribute	Private	☐	Type reference (TYPE)	XFELD			20131125

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	FREE	Instance method	Public	Method		20131125
2	GET_INSTANCE	Static method	Public	Method		20131125
3	GET_LAST_MESSAGE_STRUCT	Instance method	Public	Method		20131125
4	GET_LAST_RETURNCODE	Instance method	Public	Method		20131125
5	GET_RFC_DESTINATION	Instance method	Public	Method		20131125
6	GET_WITH_SUBSTITUTES	Instance method	Public	Method		20131125
7	GET_WI_AGENTS	Instance method	Public	Method		20131125
8	IS_ACTIVE	Instance method	Public	Method		20131125
9	READ_AGENTS_FROM_BUFFER	Instance method	Private	Method		20131125
10	READ_AGENTS_FROM_DATABASE	Instance method	Private	Method		20131125
11	SET_AGENTS_NOT_AVAILABLE	Instance method	Private	Method		20131125
12	SET_AGENTS_TO_BUFFER	Instance method	Private	Method		20131125
13	SET_RFC_DESTINATION	Instance method	Public	Method		20131125

Events

Class CL_SWN_WI_AGENTS has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	LOCAL_CALL_HISTORY	Private	See coding			20131125	begin of LOCAL_CALL_HISTORY. types: timestamp type timestampl. types: rfcdest type string. types: return_code type sytabix. types: count_records type i. types: duration_milli_seconds type i. types: end of LOCAL_CALL_HISTORY
2	LOCAL_CALL_HISTORY_TAB	Private	See coding			20131125	LOCAL_CALL_HISTORY_TAB type standard table of LOCAL_CALL_HISTORY
3	LOCAL_USER_DATA	Private	See coding			20131125	BEGIN OF local_user_data. TYPES: user TYPE string. TYPES: is_substitute TYPE string. TYPES: subst_for_otype TYPE string. TYPES: subst_for_objid TYPE string. TYPES: END OF local_user_data
4	LOCAL_USER_DATA_TAB	Private	See coding			20131125	local_user_data_tab TYPE STANDARD TABLE OF local_user_data WITH KEY user
5	LOCAL_WI_AGENT	Private	See coding			20131125	BEGIN OF local_wi_agent. TYPES: wi_id TYPE i. TYPES: general TYPE string. TYPES: no_agent_available type string. TYPES: user_data TYPE local_user_data_tab. TYPES: END OF local_wi_agent
6	LOCAL_WI_AGENT_TAB	Private	See coding			20131125	local_wi_agent_tab TYPE SORTED TABLE OF local_wi_agent WITH UNIQUE KEY wi_id

Method Signatures

Method FREE Signature

Method FREE on class CL_SWN_WI_AGENTS has no parameter.
Method FREE on class CL_SWN_WI_AGENTS has no exception.

Method GET_INSTANCE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DESTINATION	Call by reference	☑	Type reference (TYPE)	RFCDEST			20131125
2	Importing	IM_WITH_SUBSTITUTES	Call by reference	☐	Type reference (TYPE)	XFELD	SPACE		20131125
3	Returning	RE_INSTANCE	Value transfer	☐	Object reference (TYPE REF TO)	CL_SWN_WI_AGENTS			20131125

Method GET_INSTANCE on class CL_SWN_WI_AGENTS has no exception.

Method GET_LAST_MESSAGE_STRUCT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_MESSAGE_STRUCT	Value transfer	☐	Type reference (TYPE)	SWRTMSTRUC			20131125

Method GET_LAST_MESSAGE_STRUCT on class CL_SWN_WI_AGENTS has no exception.

Method GET_LAST_RETURNCODE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_RETURNCODE	Value transfer	☐	Type reference (TYPE)	SYSUBRC			20131125

Method GET_LAST_RETURNCODE on class CL_SWN_WI_AGENTS has no exception.

Method GET_RFC_DESTINATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_DESTINATION	Value transfer	☐	Type reference (TYPE)	RFCDEST			20131125

Method GET_RFC_DESTINATION on class CL_SWN_WI_AGENTS has no exception.

Method GET_WITH_SUBSTITUTES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_WITH_SUBSTITUTES	Value transfer	☐	Type reference (TYPE)	XFELD			20131125

#	Exception	Resumable	Description	Created on
1	CX_SWF_RUN_WIM	☐		20131125

Method GET_WI_AGENTS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_WIIDS	Call by reference	☐	Type reference (TYPE)	SWRTWIID			20131125
2	Returning	RE_AGENTS	Value transfer	☐	Type reference (TYPE)	SWRTWIAGENT			20131125

#	Exception	Resumable	Description	Created on
1	CX_SWF_RUN_WIM	☐		20131125

Method IS_ACTIVE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ACTIVE	Value transfer	☐	Type reference (TYPE)	XFELD			20131125

Method IS_ACTIVE on class CL_SWN_WI_AGENTS has no exception.

Method READ_AGENTS_FROM_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_AGENTS	Call by reference	☐	Type reference (TYPE)	SWRTWIAGENT			20131125
2	Exporting	EX_WIIDS_NOT_IN_BUFFER	Call by reference	☐	Type reference (TYPE)	SWRTWIID			20131125
3	Importing	IM_WIIDS	Call by reference	☐	Type reference (TYPE)	SWRTWIID			20131125

Method READ_AGENTS_FROM_BUFFER on class CL_SWN_WI_AGENTS has no exception.

Method READ_AGENTS_FROM_DATABASE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	EX_AGENTS	Call by reference	☐	Type reference (TYPE)	SWRTWIAGENT			20131125
2	Importing	IM_WIIDS	Call by reference	☐	Type reference (TYPE)	SWRTWIID			20131125

#	Exception	Resumable	Description	Created on
1	CX_SWF_RUN_WIM	☐		20131125

Method SET_AGENTS_NOT_AVAILABLE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_AGENTS_AVAILABLE	Call by reference	☐	Type reference (TYPE)	SWRTWIAGENT			20131125
2	Importing	IM_WIIDS	Call by reference	☐	Type reference (TYPE)	SWRTWIID			20131125

Method SET_AGENTS_NOT_AVAILABLE on class CL_SWN_WI_AGENTS has no exception.

Method SET_AGENTS_TO_BUFFER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_AGENTS	Call by reference	☐	Type reference (TYPE)	SWRTWIAGENT			20131125

Method SET_AGENTS_TO_BUFFER on class CL_SWN_WI_AGENTS has no exception.

Method SET_RFC_DESTINATION Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_DESTINATION	Value transfer	☐	Type reference (TYPE)	RFCDEST			20131125

Method SET_RFC_DESTINATION on class CL_SWN_WI_AGENTS has no exception.

History

Last changed by/on	SAP	20141121
SAP Release Created in	740