SAP ABAP Class CNV_00001_MESSAGE_COLLECTOR (Collects and categorizes messages)

Hierarchy

☛ DMIS (Software Component) DMIS 2011_1
   ⤷ CA-GTF-BS (Application Component) Business Application Support
     ⤷ CNV_BASIS (Package) Conversion: Basis functions

Properties

Class	CNV_00001_MESSAGE_COLLECTOR
Short Description	Collects and categorizes messages
Super Class
Instantiability of a Class	2	Public
Final	☐

General Data

Message Class
Program status
Category	0
Package	CNV_BASIS	Conversion: Basis functions
Created	20091103	SAP
Last change	20141030
Shared Memory-enabled	☐
Fixed point arithmetic	☑
Unicode checks active	☑

Forward declarations

Class CNV_00001_MESSAGE_COLLECTOR has no forward declaration.

Interfaces

Class CNV_00001_MESSAGE_COLLECTOR has no interface implemented.

Friends

Class CNV_00001_MESSAGE_COLLECTOR has no friend class.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	BATCH	Instance attribute	Protected	☐	Type reference (TYPE)	AS4FLAG	'X'	Whether to show messages for batch mode	20091113
2	CAT_FIELD	Static Attribute	Protected	☐	Type reference (TYPE)	TY_T_CAT_FIELD		Mapping: category -> dynpro field	20091103
3	DIALOG	Instance attribute	Protected	☐	Type reference (TYPE)	AS4FLAG	'X'	Whether to show messages for dialog mode	20091113
4	FIELDS	Static Attribute	Protected	☐	Type reference (TYPE)	CNV_00001_DYNFNAM_TT		List of dynpro field names	20091103
5	FIELD_CAT	Static Attribute	Protected	☐	Type reference (TYPE)	TY_T_FIELD_CAT		Mapping: field -> category	20091103
6	FIELD_TYPE_ICON	Constant	Public	☐	Type reference (TYPE)	CHAR1	'I'	Type of message receiving field	20091103
7	FIELD_TYPE_MESSAGE	Constant	Public	☐	Type reference (TYPE)	CHAR1	'M'	Type of message receiving field	20091103
8	LOW_LEVEL_MESSAGES	Instance attribute	Protected	☐	Type reference (TYPE)	CNV_00001_MESSAGE_CL_TT		List of messages	20091103
9	MESSAGES	Instance attribute	Protected	☐	Type reference (TYPE)	TY_T_MESSAGE		List of messages	20091103

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_FIELD_CAT_MAPPING	Static method	Public	Method	Adds a mapping field <-> message category	20091103
2	CLEAR	Instance method	Public	Method	Clears the messages of a given category	20091103
3	CONSTRUCTOR	Instance method	Public	Constructor	Constructs a message collector	20091103
4	GET_CATEGORY_FOR_FIELD	Static method	Public	Method	Returns the category for the given dynpro field	20091103
5	GET_FIELDS	Static method	Public	Method	Returns all mapped dynpro fields	20091103
6	GET_FIELDS_FOR_CATEGORY	Static method	Public	Method	Returns dynpro fields for a given category	20091103
7	GET_LOW_LEVEL_MESSAGES	Instance method	Public	Method	Returns the low level messages	20091103
8	GET_MESSAGE	Instance method	Public	Method	Returns the top message for a given category	20091103
9	GET_MESSAGES	Instance method	Public	Method	Returns the messages for a given category	20091103
10	GET_STATUS	Instance method	Public	Method	Gets status for a given category	20091103
11	POST	Instance method	Public	Method	Posts a message to the collector	20091103

Events

#	Event	Type	Visibility	Description	Created on
1	MESSAGE_RECEIVED	Instance Event (0)	Public (2)	Message received	20091103

Types

#	Type	Visibility	Typing	Associated Type	Description	Created on	Type Source
1	TY_CAT_MAPPING	Protected	See coding		TY_CAT_MAPPING	20091103
2	TY_MESSAGE	Protected	See coding		Structure for sorted table of messages	20091103
3	TY_T_CAT_FIELD	Protected	See coding		TY_T_CAT_FIELD	20091103
4	TY_T_FIELD_CAT	Protected	See coding		TY_T_FIELD_CAT	20091103
5	TY_T_MESSAGE	Protected	See coding		Table of messages sorted by severity	20091103

Method Signatures

Method ADD_FIELD_CAT_MAPPING Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATEGORY	Call by reference	☐	Type reference (TYPE)	CNV_00001_MSGCAT		Category of a message	20091103
2	Importing	FIELD	Call by reference	☐	Type reference (TYPE)	CHAR30		Field name	20091103
3	Importing	TEXT	Call by reference	☐	Type reference (TYPE)	CHAR128	SPACE	128 character	20091103
4	Importing	TRIGGER_EVENT	Call by reference	☐	Type reference (TYPE)	AS4FLAG	'X'	whether to trigger an event	20091103
5	Importing	TYPE	Call by reference	☐	Type reference (TYPE)	CHAR1	FIELD_TYPE_MESSAGE	Type of field	20091103

Method ADD_FIELD_CAT_MAPPING on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method CLEAR Signature

Method CLEAR on class CNV_00001_MESSAGE_COLLECTOR has no parameter.
Method CLEAR on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method CONSTRUCTOR Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	BATCH	Call by reference	☐	Type reference (TYPE)	AS4FLAG	'X'	Flag (X or blank)	20091113
2	Importing	DIALOG	Call by reference	☐	Type reference (TYPE)	AS4FLAG	'X'	Flag (X or blank)	20091113

Method CONSTRUCTOR on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method GET_CATEGORY_FOR_FIELD Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	CATEGORY	Value transfer	☐	Type reference (TYPE)	CNV_00001_MSGCAT		Category of a message	20091103
2	Importing	FIELD	Call by reference	☐	Type reference (TYPE)	DYNFNAM		Field name	20091103
3	Exporting	TEXT	Value transfer	☐	Type reference (TYPE)	CHAR128		128 character	20091103
4	Exporting	TYPE	Value transfer	☐	Type reference (TYPE)	CHAR1		Field type	20091103

Method GET_CATEGORY_FOR_FIELD on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method GET_FIELDS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	FIELDS	Call by reference	☐	Type reference (TYPE)	CNV_00001_DYNFNAM_TT		List of dynpro field names	20091103

Method GET_FIELDS on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method GET_FIELDS_FOR_CATEGORY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATEGORY	Call by reference	☐	Type reference (TYPE)	CNV_00001_MSGCAT		Category of a message	20091103
2	Returning	FIELDS	Value transfer	☐	Type reference (TYPE)	CNV_00001_DYNFNAM_TT		List of fields	20091103

Method GET_FIELDS_FOR_CATEGORY on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method GET_LOW_LEVEL_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Exporting	MESSAGES	Call by reference	☐	Type reference (TYPE)	CNV_00001_MESSAGE_CL_TT		List of messages	20091103

Method GET_LOW_LEVEL_MESSAGES on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method GET_MESSAGE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATEGORY	Call by reference	☑	Type reference (TYPE)	CNV_00001_MSGCAT		Category of a message	20091103
2	Exporting	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	CNV_00001_MESSAGE		Message	20091103

Method GET_MESSAGE on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method GET_MESSAGES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATEGORY	Call by reference	☑	Type reference (TYPE)	CNV_00001_MSGCAT		Category of a message	20091103
2	Exporting	MESSAGES	Call by reference	☐	Type reference (TYPE)	CNV_00001_MESSAGE_CL_TT		List of messages	20091103

Method GET_MESSAGES on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method GET_STATUS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	CATEGORY	Call by reference	☐	Type reference (TYPE)	CNV_00001_MSGCAT		Category of a message	20091103
2	Returning	STATUS	Value transfer	☐	Type reference (TYPE)	CNV_00001_MSGTYPE		Message type	20091103

Method GET_STATUS on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Method POST Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	MESSAGE	Call by reference	☐	Object reference (TYPE REF TO)	CNV_00001_MESSAGE		Info / warning / error message representation	20091103
2	Importing	PARAMETERS	Call by reference	☑	Type reference (TYPE)	CNV_00001_SPAR_TT		Table of parameters	20091103

Method POST on class CNV_00001_MESSAGE_COLLECTOR has no exception.

Event Signatures

Event MESSAGE_RECEIVED Signature

#	Parameter	Type	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	MESSAGE	Exporting	Value transfer	☐	Object reference (TYPE REF TO)	CNV_00001_MESSAGE		Info / warning / error message representation	20091103
2	PARAMETERS	Exporting	Value transfer	☑	Type reference (TYPE)	CNV_00001_SPAR_TT		Table of parameters	20091103

History

Last changed by/on	SAP	20141030
SAP Release Created in	46C