SAP ABAP Class CL_FDT_WD_ISLAND_MSG_MANAGER (FDT WD Island: Manages Messages)

Hierarchy

☛ SAP_BASIS (Software Component) SAP Basis Component
   ⤷ BC-SRV-BR (Application Component) BRFplus - ABAP-Based Business Rules
     ⤷ SFDT_WD_ISLAND_INFRASTRUCTURE (Package) BRFplus: Island Infrastructure

Meta Relationship - Using

#	Relationship type	Using	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	IF_FDT_WD_ISLAND_MSG_MANAGER	FDT WD: Island Message Manager used in control models	20110413

Properties

Class	CL_FDT_WD_ISLAND_MSG_MANAGER
Short Description	FDT WD Island: Manages Messages
Super Class
Instantiability of a Class	2	Public
Final	☑

General Data

Message Class
Program status
Category	0
Package	SFDT_WD_ISLAND_INFRASTRUCTURE	BRFplus: Island Infrastructure
Created	20110322	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	CL_FDT_WD_ISLAND_CTRL_MANAGER	Forward declaration class (CLASS c DEFINITION DEFERRED)	Forward declaration class (CLASS c DEFINITION DEFERRED)
3	IF_FDT_TYPES	Forward declaration interface (INTERFACE i DEFINITION DEF...	Forward declaration interface (INTERFACE i DEFINITION DEF...

Interfaces

#	Interface	Abstract	Final	Description	Created on
1	IF_FDT_WD_ISLAND_MSG_MANAGER	☐	☐	FDT WD: Island Message Manager used in control models	20110413

Friends

#	Friend	Modeled only	Created on	Description
1	CL_FDT_WD_ISLAND_UT_HELPER	☐	20121128	FDT WD Island: Unit Test Helper

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	GC_XML_ATTR_IS_ROOT_OBJECT	Constant	Private	☐	Type reference (TYPE)	STRING	'is_root'	True: is root object	20111216
2	GV_FIRST_MESSAGE	Static Attribute	Public	☑	Type reference (TYPE)	BOOLE_D	ABAP_TRUE	True: first message in processing, not sent yet	20120220
3	MO_CONFIGURATION	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FDT_WD_CONFIGURATION		FDT WD: Configuration	20110322
4	MO_CONTROL_MANAGER	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_CTRL_MANAGER		Control Manager	20110620
5	MO_CURRENT_RESPONSE	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MESSAGE		Current response in processing	20111111
6	MO_FACTORY	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_FACTORY		FDT WD: Factory for Island components	20110322
7	MO_LAST_MESSAGE_SEND	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		last message, which was send	20120612
8	MO_MESSAGE_NODE	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Message Context Node	20110322
9	MO_META_DATA_MODEL	Instance attribute	Public	☑	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_META_MODEL		FDT Island: Metadata XML Stream	20110620
10	MO_WD_APPLICATION	Instance attribute	Public	☑	Object reference (TYPE REF TO)	IF_WD_APPLICATION		Island WD application	20120215
11	MO_WD_MESSAGE_MANAGER	Instance attribute	Private	☐	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message Manager	20111124
12	MS_CURRENT_ROOT_OBJECT	Instance attribute	Public	☑	Type reference (TYPE)	S_ROOT_OBJECT		Current Root Object	20110630
13	MV_CURRENT_ROOT_CONTROL	Instance attribute	Public	☑	Type reference (TYPE)	CL_FDT_WD_ISLAND_CTRL_MANAGER=>CONTROL_HANDLE		Root Control Handle	20110620
14	MV_LAST_SERIALIZED_MESSAGE	Instance attribute	Private	☐	Type reference (TYPE)	STRING		last serialized message	20110322
15	MV_SIMULATION_MODE	Instance attribute	Public	☑	Type reference (TYPE)	BOOLE_D		True: simulation mode, used for unit testing	20110322

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_CONTROL	Instance method	Private	Method	Adds a new control	20110620
2	CHECK_ADD_SUBCONTROL_NEEDED	Instance method	Private	Method	Check if a subcontrol needs to be created	20110621
3	CHECK_DO_RESET_REPOSITORY	Instance method	Private	Method	Checks if the repository in SL needs to be reseted	20121128
4	CHECK_SEND_CURRENT_RESPONSE	Instance method	Private	Method	Check, whether the current response can be sent or not	20120621
5	CONSTRUCTOR	Instance method	Public	Constructor	CONSTRUCTOR	20110322
6	CREATE_INPUT_ASSISTENT_REQUEST	Instance method	Private	Method	Creates the initial request for the input assistent	20120104
7	GET_LAST_MESSAGE	Instance method	Public	Method	Returns the last message(for Unit Testing)	20110622
8	GET_LAST_SERIALIZED_MESSAGE	Instance method	Public	Method	Returns the last serialized message(for Unit Testing)	20110322
9	GET_ROOT_MODEL	Instance method	Public	Method	Returns the model of the current root control	20111107
10	HANDLE_CONTROL_MESSAGE	Instance method	Private	Method	Handles Messages for Island Controls	20111124
11	PARSE_PROCESS_MESSAGE	Instance method	Private	Method	Reads a message from the xml stream	20120320
12	PARSE_PROCESS_MESSAGES	Instance method	Public	Method	Parses and process message from xml stream	20120320
13	PREPARE_SEND_RESPONSE	Instance method	Private	Method	Prepares the sending of a response	20120314
14	SEND_INITIAL_MESSAGE	Instance method	Public	Method	Sends the initial message	20110630
15	SEND_MESSAGE	Instance method	Private	Method	Sends the message to the Island	20110322
16	SEND_REQUEST	Instance method	Public	Method	Sends the request	20111019
17	SEND_RESPONSE_FROM_WD_COMP	Instance method	Public	Method	Sends the response(used by Island WD Comp)	20120314
18	SET_ROOT_OBJECT	Instance method	Public	Method	Sets the current root object of the control	20110322

Events

Class CL_FDT_WD_ISLAND_MSG_MANAGER has no event.

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	S_ROOT_OBJECT	Public	See coding			20110630	begin of S_ROOT_OBJECT, id type if_fdt_types=>id, is_new type abap_bool, "= true means that the control was displayed for the first time is_revisited type abap_bool, "= true means that the control is redisplayed (was hidden) end of s_root_object

Method Signatures

Method ADD_CONTROL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_AS_CHILD	Call by reference	☑	Type reference (TYPE)	BOOLE_D		Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20110620
2	Importing	IV_CONTROL_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Control Name	20110621
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		Id	20110620
4	Importing	IV_PARENT_CONTROL	Call by reference	☑	Type reference (TYPE)	CL_FDT_WD_ISLAND_CTRL_MANAGER=>CONTROL_HANDLE		Parent Control	20120104
5	Importing	IV_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP		Timestamp	20110620
6	Returning	RV_CONTROL_HANDLE	Value transfer	☐	Type reference (TYPE)	CL_FDT_WD_ISLAND_CTRL_MANAGER=>CONTROL_HANDLE		Handle of the created control	20120104

Method ADD_CONTROL on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method CHECK_ADD_SUBCONTROL_NEEDED Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		FDT WD: Message	20110621

Method CHECK_ADD_SUBCONTROL_NEEDED on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method CHECK_DO_RESET_REPOSITORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MSG_INIT		FDT WD Island: Interface for Initialize Contorl Message	20121128
2	Importing	IV_CURRENT_CONTROL_HANDLE	Call by reference	☐	Type reference (TYPE)	CL_FDT_WD_ISLAND_CTRL_MANAGER=>CONTROL_HANDLE		Control Handle ID	20121128

Method CHECK_DO_RESET_REPOSITORY on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method CHECK_SEND_CURRENT_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MESSAGE		FDT WD Island: Message	20120621
2	Returning	RV_SEND_MESSAGE	Value transfer	☐	Type reference (TYPE)	ABAP_BOOL			20120621

Method CHECK_SEND_CURRENT_RESPONSE on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_CONFIGURATION	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_CONFIGURATION		FDT WD: Configuration	20110322
2	Importing	IO_MESSAGE_MANAGER	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_MESSAGE_MANAGER		Message Manager	20110510
3	Importing	IO_MESSAGE_NODE	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_CONTEXT_NODE		Message Context Node	20110502
4	Importing	IO_WD_APPLICATION	Call by reference	☑	Object reference (TYPE REF TO)	IF_WD_APPLICATION		WD Application	20120215
5	Importing	IV_SIMULATION_MODE	Call by reference	☐	Type reference (TYPE)	ABAP_BOOL	ABAP_FALSE	True: used for unit testing	20110322

Method CONSTRUCTOR on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method CREATE_INPUT_ASSISTENT_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_PARENT_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MESSAGE		Parent Message	20120104
2	Importing	IV_PARENT_CONTROL	Call by reference	☐	Type reference (TYPE)	CL_FDT_WD_ISLAND_CTRL_MANAGER=>CONTROL_HANDLE		Control Handle for parent control	20120104

Method CREATE_INPUT_ASSISTENT_REQUEST on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method GET_LAST_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		Message	20110622

Method GET_LAST_MESSAGE on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method GET_LAST_SERIALIZED_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RV_MESSAGE	Value transfer	☐	Type reference (TYPE)	STRING			20110322

Method GET_LAST_SERIALIZED_MESSAGE on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method GET_ROOT_MODEL Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RO_MODEL	Value transfer	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MODEL		FDT WD: Island Model	20111107

Method GET_ROOT_MODEL on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method HANDLE_CONTROL_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		FDT WD: Message	20111124

Method HANDLE_CONTROL_MESSAGE on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method PARSE_PROCESS_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_XML_READER	Call by reference	☐	Object reference (TYPE REF TO)	IF_SXML_READER		XML reader	20120320
2	Returning	RO_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MESSAGE		FDT WD: Message	20120320

#	Exception	Resumable	Description	Created on
1	CX_FDT_SYSTEM	☐	FDT: System Failure	20120320

Method PARSE_PROCESS_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IV_XML_STREAM	Call by reference	☐	Type reference (TYPE)	STRING			20120320
2	Returning	RO_MESSAGE	Value transfer	☐	Object reference (TYPE REF TO)	CL_FDT_WD_ISLAND_MESSAGE		FDT WD: Message	20120320

#	Exception	Resumable	Description	Created on
1	CX_FDT_SYSTEM	☐	FDT: System Failure	20120320

Method PREPARE_SEND_RESPONSE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		Message	20120314

Method PREPARE_SEND_RESPONSE on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method SEND_INITIAL_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STATE	Call by reference	☑	Object reference (TYPE REF TO)	IF_FDT_WD_STATE		FDT WD: State	20120319
2	Importing	IV_IS_ROOT_CONTROL	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_FALSE	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20111216

Method SEND_INITIAL_MESSAGE on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method SEND_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		FDT WD: Message	20110502
2	Importing	IV_PREPARE_NECESSARY	Call by reference	☐	Type reference (TYPE)	BOOLE_D	ABAP_TRUE	Data element for domain BOOLE: TRUE (='X') and FALSE (=' ')	20111111

Method SEND_MESSAGE on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method SEND_REQUEST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_REQUEST	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		Request	20111019

Method SEND_REQUEST on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method SEND_RESPONSE_FROM_WD_COMP Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_RESPONSE	Call by reference	☐	Object reference (TYPE REF TO)	IF_FDT_WD_ISLAND_MESSAGE		Message	20120314

Method SEND_RESPONSE_FROM_WD_COMP on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

Method SET_ROOT_OBJECT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IO_STATE	Call by reference	☑	Object reference (TYPE REF TO)	IF_FDT_WD_STATE		FDT WD: State	20120220
2	Importing	IV_CONTROL_NAME	Call by reference	☑	Type reference (TYPE)	STRING		Control Name (Only for unit testing!)	20111125
3	Importing	IV_ID	Call by reference	☐	Type reference (TYPE)	IF_FDT_TYPES=>ID		ID	20110322
4	Importing	IV_TIMESTAMP	Call by reference	☑	Type reference (TYPE)	IF_FDT_TYPES=>TIMESTAMP		Timestamp	20110322

Method SET_ROOT_OBJECT on class CL_FDT_WD_ISLAND_MSG_MANAGER has no exception.

History

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