IF_WD_MESSAGE_MANAGER
This interface is used as a message manager for messages integration, and is available to application developers in the Web Dynpro code wizard.
Only the most important methods are listed below. For a description of the individual parameters for these methods, see the method documentation in the system.
Methods
Note that the RAISE methods are deprecated. For this reason you should not use them.
Also note that the msg_user_data parameter used with most of the methods is only available for special purposes. For this reason you should not use it.
For the relevant methods you can use the optional VIEW parameter to enter the name of the window or view in which you want to display the message.
For information on the ENABLE_MESSAGE_NAVIGATION parameter for the REPORT_ methods, see MessageArea Events.
So that application messages are not kept in the message manager for the duration of a round trip (these messages must be created new for each round trip), permanent messages are available. This enables a validity period to be inserted for a message. Possible validity periods are:
● Life span of the component
● Life span of the controller.
● Life span of the context (only for messages that relate to a context attribute)
The IS_PERMANENT and SCOPE_PERMANENT_MSG parameters are available for this.
In REPORT_ATTRIBUTE_* methods you specify the reference to the context element and the attribute names in the signature. If you display an InputField in your view that is bound to the relevant context, Web Dynpro Framework displays a link to an error message referring to an erroneous entry. The user can then click on this link.
REPORT_EXCEPTION
Reports a Web Dynpro exception (may revert)
REPORT_SUCCESS
Reports a success
message (
)
REPORT_WARNING
Reports a warning
(
).
REPORT_ATTRIBUTE_ERROR_MESSAGE
Reports a Web Dynpro exception for a context attribute
This method reports an error message for a context attribute. A context-related error message influences the flow of the Web Dynpro phase model. If this type of error message is generated before an action handler is called (for example, in WDDOBEFOREACTION methods), actions of the type standard are no longer executed. Subsequent navigation and WDDOMODIFYVIEW methods are also not executed. However, validation-independent actions are executed even if error messages exist. Subsequent navigation and WDDOMODIFYVIEW methods are also executed.
REPORT_ATTRIBUTE_EXCEPTION
Reports a Web Dynpro exception for a context attribute
This method reports an error message for a context attribute. A context-related error message influences the flow of the Web Dynpro phase model. If this type of error message is generated before an action handler is called (for example, in WDDOBEFOREACTION methods), actions of the type standard are no longer executed. Subsequent navigation and WDDOMODIFYVIEW methods are also not executed. However, validation-independent actions are executed even if error messages exist. Subsequent navigation and WDDOMODIFYVIEW methods are also executed.
REPORT_ERROR_MESSAGE
Reports a Web
Dynpro error message (
) with
optional parameters. You can transfer a string here. This should be either a
user-defined
OTR text or a text from an exception class. Use hard coding
for the text to ensure that it can be easily translated.
IS_EMPTY
Queries whether or not there are any messages
REPORT_T100_MESSAGE
Reports a message using a T100 entry
You can find an example in Integration of Messages in the Message Log.
REPORT_FATAL_EXCEPTION
This method reports a termination message. The reporting of a message of this type in the following methods causes the Web Dynpro application to terminate with a runtime error:
● WDDOINIT
● WDDOEXIT:
● WDDOMODIFYVIEW
● Within an inbound plug event handler
If a message of this type is generated in WDDOBEFORENAVIGATION or WDDOPOSTPROCESSING methods or within an action handler, processing is terminated at the point in question and an error message is displayed.
REPORT_FATAL_ERROR_MESSAGE
Reports a fatal WDA message with optional parameters.
The reporting of a message of this type in the following methods causes the Web Dynpro application to terminate with a runtime error:
● WDDOINIT
● WDDOEXIT:
● WDDOMODIFYVIEW
● Within an inbound plug event handler
If a message of this type is generated in WDDOBEFORENAVIGATION or WDDOPOSTPROCESSING methods or within an action handler, processing is terminated at the point in question and an error message is displayed.
CLEAR_MESSAGES
Deletes all messages.
REPORT_ATTRIBUTE_T100_MESSAGE
Reports a Web Dynpro exception to a context attribute
REPORT_ELEMENT_ERROR_MESSAGE
Reports a Web Dynpro exception for context attributes.
This method reports an error message for a context element. A context-related error message influences the flow of the Web Dynpro phase model. If this type of error message is generated before an action handler is called (for example, in WDDOBEFOREACTION methods), actions of the type standard are no longer executed. Subsequent navigation and WDDOMODIFYVIEW methods are also not executed. However, validation-independent actions are executed even if error messages exist. Subsequent navigation and WDDOMODIFYVIEW methods are also executed.
REPORT_ELEMENT_EXCEPTION
Reports a Web Dynpro exception for context attributes.
This method reports an error message for a context element. A context-related error message influences the flow of the Web Dynpro phase model. If this type of error message is generated before an action handler is called (for example, in WDDOBEFOREACTION methods), actions of the type standard are no longer executed. Subsequent navigation and WDDOMODIFYVIEW methods are also not executed. However, validation-independent actions are executed even if error messages exist. Subsequent navigation and WDDOMODIFYVIEW methods are also executed.
REPORT_ELEMENT_T100_MESSAGE
Reports a Web Dynpro exception for context attributes.
This method reports an error message for a context element. A context-related error message influences the flow of the Web Dynpro phase model. If this type of error message is generated before an action handler is called (for example, in WDDOBEFOREACTION methods), actions of the type standard are no longer executed. Subsequent navigation and WDDOMODIFYVIEW methods are also not executed. However, validation-independent actions are executed even if error messages exist. Subsequent navigation and WDDOMODIFYVIEW methods are also executed.
REMOVE_MESSAGE
This method deletes the message for a specified ID.
HAS_VAL_ERRORS_FOR_WINDOW
This method can be used to determine whether or not error messages with a context reference exist for a particular window.
HAS_VALIDATION_ERRORS
This method can be used to check whether or not there are error messages with a context reference.
GET_MESSAGES
This method returns a list of all available messages.
GET_MESSAGE_FOR_ID
This method returns information about a message.