SAP ABAP Class CL_IBO_INBOX_SUBSTITUTE (inbox substitution)

Hierarchy

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

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_IBO_INBOX_SUBSTITUTE	inbox interface for substitutes	20090807

Properties

Class	CL_IBO_INBOX_SUBSTITUTE
Short Description	inbox substitution
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	IBO_INBOX_FEEDER	Suite Inbox Feeder
Created	20090807	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	IF_IBO_INBOX_SUBSTITUTE	☐	☐	inbox interface for substitutes	20090807

Friends

Class CL_IBO_INBOX_SUBSTITUTE has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	MC_ACTIVATE	Constant	Private	☐	Type reference (TYPE)	STRING	'ACTIVATE'		20090807
2	MC_ACTIVE	Constant	Private	☐	Type reference (TYPE)	STRING	'ACTIVE'		20090807
3	MC_ADOPTED	Constant	Private	☐	Type reference (TYPE)	STRING	'ADOPTED'		20090807
4	MC_ATR_NOMINEE	Constant	Private	☐	See coding				20101216
5	MC_BE_SYST_APPL_KEY	Constant	Private	☐	Type reference (TYPE)	POWL_APPLID_TY	'IBO_SUBSTITUTION'	Application ID	20110119
6	MC_CONTEXT_ELEMENT	Constant	Private	☐	Type reference (TYPE)	STRING	'CONTEXT_ELEMENT'		20090807
7	MC_DATEENABLED	Constant	Private	☐	Type reference (TYPE)	STRING	'DATE_ENABLED'		20090807
8	MC_DATEVISIBLE	Constant	Private	☐	Type reference (TYPE)	STRING	'DATE_VISIBLE'		20090807
9	MC_DATE_BEGIN	Constant	Private	☐	Type reference (TYPE)	STRING	'DATE_BEGIN'		20090807
10	MC_DATE_END	Constant	Private	☐	Type reference (TYPE)	STRING	'DATE_END'		20090807
11	MC_ENABLED	Constant	Private	☐	Type reference (TYPE)	STRING	'ENABLED'		20090807
12	MC_ENDDATEENABLED	Constant	Private	☐	Type reference (TYPE)	STRING	'ENDDATE_ENABLED'		20101216
13	MC_NEVERENDING	Constant	Private	☐	Type reference (TYPE)	STRING	'99991231'		20101216
14	MC_OBJID	Constant	Private	☐	Type reference (TYPE)	STRING	'OBJID'		20090807
15	MC_PROFILE	Constant	Private	☐	Type reference (TYPE)	STRING	'PROFILE'		20090807
16	MC_SELECTION	Constant	Private	☐	Type reference (TYPE)	STRING	'SELECTION'		20090807
17	MC_SWITCHEND	Constant	Private	☐	Type reference (TYPE)	STRING	'SWITCHEND'		20101216
18	MC_SWITCHEND_VALUE	Constant	Private	☐	See coding				20101216
19	MC_SWITCHON	Constant	Private	☐	Type reference (TYPE)	STRING	'SWITCHON'		20090807
20	MC_VISIBLE	Constant	Private	☐	Type reference (TYPE)	STRING	'VISIBLE'		20090807
21	MO_MESSAGE_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message Manager	20090807
22	MO_NOMINEE_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20090807
23	MO_SUBSTITUTE_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20090807
24	MO_SUBS_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Web Dynpro: Interface for Context Nodes	20090807
25	MO_SWR_API_FACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	CL_SWR_API_FACTORY		Factory for Instantiating APIs	20110119
26	MO_SWR_SUBSTITUTION_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SWR_SUBSTITUTION_API			20110119
27	MO_SWR_TEXT_API	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_SWR_TEXT_API		API for Determining Texts	20110119
28	MT_PROFILE	Static Attribute	Private	☐	Type reference (TYPE)	SWRTSUBSTPROFILE		stores profile from customizing	20090807
29	MT_SWR_SUBSTITUTES_IN_DEST	Instance attribute	Private	☐	Type reference (TYPE)	SWRTSUBSTITUTES		list with all subsitutes in any system	20110121
30	MT_SWR_SUBSTITUTIONS_IN_DEST	Instance attribute	Private	☐	Type reference (TYPE)	SWRTSUBSTITUTIONS		List with all substitution rules from any system	20110121

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADOPT_SUBSTITUTE	Instance method	Public	Method	adopts substitue	20090807
2	CONSTRUCTOR	Instance method	Public	Constructor		20110119
3	DATE_ENABLED	Instance method	Public	Method	handles enabling of date field	20090807
4	DELETE	Instance method	Public	Method	deletes substitutes	20090807
5	DELETE_SUBSTITUTE	Instance method	Public	Method		20090807
6	DISABLE_SUBSTITUTE_BY_API	Instance method	Private	Method	Disables a substitution rule using the API	20110124
7	ENABLE_SUBSTITUTE_BY_API	Instance method	Private	Method	Enables a substitution rule using the API	20110124
8	ENDDATE_ENABLED	Instance method	Public	Method	handles enabling of enddate field	20101216
9	END_TAKEOVER	Instance method	Public	Method	ends take over of substitutes	20090807
10	GET_OTHER_SUBSTITUTE	Instance method	Public	Method	Persons who are substituted by this user	20090807
11	GET_PROFILE	Instance method	Public	Method	reads profile from customizing	20090807
12	GET_RFC_LIST	Instance method	Private	Method	returns a list with all connected systems	20110125
13	GET_SUBSTITUTION_API	Instance method	Public	Method	Returns an API instance for Substitutions	20110119
14	GET_SWR_API_FACTORY	Instance method	Private	Method	Ceates an instance of the SWR API factory	20110119
15	GET_TEXT_API	Instance method	Public	Method	Returns an API instance for WF texts	20110119
16	IS_SWR_SUBSTITUTION_API_BOUND	Instance method	Public	Method	Returns, if the SWR Substitution API is bount	20110120
17	MAINTAIN_RULE	Instance method	Public	Method	maintains rule by activation and deactivation	20090807
18	REFRESH_MAIN	Instance method	Public	Method	reads all substitutes	20090807
19	REFRESH_RULE	Instance method	Public	Method	reads all substitutes	20090807
20	REPORT_T100KEY_AS_T100_MESSAGE	Instance method	Private	Method	Use given message manager to report T100 message	20090807
21	SAVE_NOMINEE	Instance method	Public	Method	Save nominee	20090807
22	SET_MAIN_VIEW	Instance method	Public	Method	Initialize main view data	20090807
23	SET_MESSAGE_MANAGER	Instance method	Public	Method		20090807
24	SET_RULE_VIEW	Instance method	Public	Method	Initialize main view data	20090807
25	TAKEOVER_SUBSTITUTE	Instance method	Public	Method	takes over or ends take over	20090807
26	UPDATE	Instance method	Public	Method	update substitutes	20090807

Events

Class CL_IBO_INBOX_SUBSTITUTE has no event.

Types

Class CL_IBO_INBOX_SUBSTITUTE has no local type.

Method Signatures

Method ADOPT_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IT_SUBSTITUTIONS	Call by reference	☐	Type reference (TYPE)	SWRTAGENT			20090807
2	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SY-LANGU			20090807
3	Importing	IV_SUBSTITUTE	Call by reference	☐	Type reference (TYPE)	SWRAGENT			20090807

#	Exception	Resumable	Description	Created on
1	CX_IBO_WF_ABORT	☐		20090807
2	CX_IBO_WF_ERROR	☐		20090807

Method CONSTRUCTOR Signature

Method CONSTRUCTOR on class CL_IBO_INBOX_SUBSTITUTE has no parameter.
Method CONSTRUCTOR on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method DATE_ENABLED Signature

Method DATE_ENABLED on class CL_IBO_INBOX_SUBSTITUTE has no parameter.
Method DATE_ENABLED on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method DELETE 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)	SWRTAGENT			20090807
2	Importing	IV_END_DATE	Call by reference	☑	Type reference (TYPE)	SYDATUM			20090807
3	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU			20090807
4	Importing	IV_START_DATE	Call by reference	☑	Type reference (TYPE)	SYDATUM			20090807
5	Importing	IV_SUBSTITUTE	Call by reference	☐	Type reference (TYPE)	SWRAGENT			20090807

Method DELETE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method DELETE_SUBSTITUTE Signature

Method DELETE_SUBSTITUTE on class CL_IBO_INBOX_SUBSTITUTE has no parameter.
Method DELETE_SUBSTITUTE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method DISABLE_SUBSTITUTE_BY_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	IBO_T_WF_FACADE_MESSAGE		message table	20110124
2	Importing	IS_SUBSTITUTE	Call by reference	☐	Type reference (TYPE)	SWRAGENT		Role Resolution Result	20110124
3	Importing	IV_END_DATE	Call by reference	☑	Type reference (TYPE)	SWR_SUBSTEND		End of Substitution	20120119
4	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU		Language Key of Current Text Environment	20110124
5	Importing	IV_START_DATE	Call by reference	☑	Type reference (TYPE)	SWR_SUBSTBEGIN		Start of Substitution	20120119

#	Exception	Resumable	Description	Created on
1	CX_IBO_WF_ABORT	☐	IBO WF root exception for program errors (unrecoverable)	20110124
2	CX_IBO_WF_ERROR	☐	CX static check	20110124

Method ENABLE_SUBSTITUTE_BY_API Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_MESSAGE	Call by reference	☐	Type reference (TYPE)	IBO_T_WF_FACADE_MESSAGE		message table	20110124
2	Importing	IS_SUBSTITUTE	Call by reference	☐	Type reference (TYPE)	IBO_S_WF_SUBSTITUTE		substitute for lean inbox	20110124
3	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU		Language Key of Current Text Environment	20110124

#	Exception	Resumable	Description	Created on
1	CX_IBO_WF_ABORT	☐	IBO WF root exception for program errors (unrecoverable)	20110124
2	CX_IBO_WF_ERROR	☐	CX static check	20110124

Method ENDDATE_ENABLED Signature

Method ENDDATE_ENABLED on class CL_IBO_INBOX_SUBSTITUTE has no parameter.
Method ENDDATE_ENABLED on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method END_TAKEOVER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Changing	IT_SUBSTITUTION	Call by reference	☐	Type reference (TYPE)	SWRTAGENT			20090807
2	Importing	IV_LANGUAGE	Call by reference	☐	Type reference (TYPE)	SYLANGU			20090807
3	Importing	IV_SUBSTITUTE	Call by reference	☐	Type reference (TYPE)	SWRAGENT			20090807

#	Exception	Resumable	Description	Created on
1	CX_IBO_WF_ABORT	☐		20090807
2	CX_IBO_WF_ERROR	☐		20090807

Method GET_OTHER_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SUBSTITUTION	Call by reference	☐	Type reference (TYPE)	SWRTSUBSTITUTION			20090807
2	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU			20090807
3	Importing	IV_USER_ID	Call by reference	☐	Type reference (TYPE)	SYUNAME			20090807

#	Exception	Resumable	Description	Created on
1	CX_IBO_WF_ABORT	☐		20090807
2	CX_IBO_WF_ERROR	☐		20090807

Method GET_PROFILE Signature

Method GET_PROFILE on class CL_IBO_INBOX_SUBSTITUTE has no parameter.
Method GET_PROFILE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method GET_RFC_LIST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_INCLUDE_LOCAL	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	'X'	create list including the local system	20110125
2	Returning	RT_RFC_DEST	Value transfer	☐	Type reference (TYPE)	SWRTRFCDEST		RFC Destinations	20110125

Method GET_RFC_LIST on class CL_IBO_INBOX_SUBSTITUTE has no exception.

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		Instance of Substituton API	20110119

Method GET_SUBSTITUTION_API on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method GET_SWR_API_FACTORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_API_FACTORY_BOUND	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		API Factory is bound	20110119

Method GET_SWR_API_FACTORY on class CL_IBO_INBOX_SUBSTITUTE 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	20110119

Method GET_TEXT_API on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method IS_SWR_SUBSTITUTION_API_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		Returns true, if Substitution API can be used	20110120

Method IS_SWR_SUBSTITUTION_API_BOUND on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method MAINTAIN_RULE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_WD_EVENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT			20090807

Method MAINTAIN_RULE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method REFRESH_MAIN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	ET_SUBSTITUTE	Call by reference	☐	Type reference (TYPE)	SWRTSUBSTITUTE			20090807
2	Importing	IS_AGENT	Call by reference	☐	Type reference (TYPE)	SYUNAME			20090807
3	Importing	I_END_DATE	Call by reference	☑	Type reference (TYPE)	SWR_SUBSTEND			20090807
4	Importing	I_LANGU	Call by reference	☑	Type reference (TYPE)	SYLANGU			20090807
5	Importing	I_START_DATE	Call by reference	☑	Type reference (TYPE)	SWR_SUBSTBEGIN			20090807

Method REFRESH_MAIN on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method REFRESH_RULE Signature

Method REFRESH_RULE on class CL_IBO_INBOX_SUBSTITUTE has no parameter.
Method REFRESH_RULE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method REPORT_T100KEY_AS_T100_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message Manager	20090807
2	Importing	IS_T100KEY	Call by reference	☐	Type reference (TYPE)	SCX_T100KEY		T100 Key with Parameters Mapped to Attribute Names	20090807

Method REPORT_T100KEY_AS_T100_MESSAGE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method SAVE_NOMINEE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Flag if nominee has been saved successfully	20091207

Method SAVE_NOMINEE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method SET_MAIN_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_NOMINEE_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE			20090807

Method SET_MAIN_VIEW on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method SET_MESSAGE_MANAGER Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE_MANAGER	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER			20090807

Method SET_MESSAGE_MANAGER on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method SET_RULE_VIEW Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_SUBSTITUTE_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE			20090807
2	Importing	IO_SUBS_NODE	Call by reference	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE			20090807

Method SET_RULE_VIEW on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method TAKEOVER_SUBSTITUTE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_WD_EVENT	Call by reference	☑	Object reference (TYPE REF TO)	CL_WD_CUSTOM_EVENT			20090807

Method TAKEOVER_SUBSTITUTE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

Method UPDATE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_END_DATE	Call by reference	☑	Type reference (TYPE)	SYDATUM			20090807
2	Importing	IV_LANGUAGE	Call by reference	☑	Type reference (TYPE)	SYLANGU			20090807
3	Importing	IV_START_DATE	Call by reference	☑	Type reference (TYPE)	SYDATUM			20090807
4	Importing	IV_SUBSTITUTE	Call by reference	☑	Type reference (TYPE)	SWRAGENT			20090807
5	Importing	IV_SUBST_ACTIVE	Call by reference	☑	Type reference (TYPE)	ABAP_BOOL			20090807
6	Importing	IV_SUBST_PROFILE	Call by reference	☑	Type reference (TYPE)	SWR_SUBSTPROF			20090807
7	Importing	IV_USER_ID	Call by reference	☐	Type reference (TYPE)	SYUNAME			20090807
8	Returning	RV_RESULT	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL		Flag if substitute has been updated successfully.	20091207

Method UPDATE on class CL_IBO_INBOX_SUBSTITUTE has no exception.

History

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