com.sap.cloud.sdk.service.prov.api

Interface MessageContainer

All Known Implementing Classes:

MessageContainerImpl

public interface MessageContainer

Method Summary

Modifier and Type	Method and Description
void	addErrorMessage(String messageKey, String target, Object... params) Adds a (non-leading)message with severity error.
void	addInfoMessage(String messageKey, String target, Object... params) Adds a (non-leading)message with severity info.
void	addSuccessMessage(String messageKey, String target, Object... params) Adds a (non-leading)message with severity success.
void	addWarningMessage(String messageKey, String target, Object... params) Adds a (non-leading)message with severity warning.
void	setLeadingMessage(String messageKey, String target, Object... params) Sets the leading message.

Method Detail

addErrorMessage

void addErrorMessage(String messageKey,
                     String target,
                     Object... params)

Adds a (non-leading)message with severity error. The message text of the message will be obtained from a properties file based on the messageKey parameter. The messageKey parameter also becomes the "code" of the message. Parameters is taken through a variable length array of objects. These objects will be stringified and substituted in the messageText in place of parameter place holders. In case there are no parameters, just don't pass any objects for this argument. Once the message is added to the container by calling this api, it can come as part of details under the value of the sap-message header, or as error detail in an error response based on the calls taken by the developer.

Parameters:

messageKey - messageKey associated with the message, used as the key to a properties file to retrieve the message text.

target - Target for which this message applies.

params - Parameters which will be substituted in the messageText in place of placeholders.

setLeadingMessage

void setLeadingMessage(String messageKey,
                       String target,
                       Object... params)

Sets the leading message. The message text of the message will be obtained from a properties file based on the messageKey parameter. The messageKey parameter also becomes the "code" of the message. Parameters is taken through a variable length array of objects. These objects will be stringified and substituted in the messageText in place of parameter place holders. In case there are no parameters, just don't pass any objects for this argument. This will be the leading message under the value of the sap-message header. The severity is always success for the leading message.

Parameters:

messageKey - messageKey associated with the message, used as the key to a properties file to retrieve the message text.

target - Target for which this message applies.

params - Parameters which will be substituted in the messageText in place of placeholders.

addWarningMessage

void addWarningMessage(String messageKey,
                       String target,
                       Object... params)

Adds a (non-leading)message with severity warning. The message text of the message will be obtained from a properties file based on the messageKey parameter. The messageKey parameter also becomes the "code" of the message. Parameters is taken through a variable length array of objects. These objects will be stringified and substituted in the messageText in place of parameter place holders. In case there are no parameters, just don't pass any objects for this argument. Once the message is added to the container by calling this api, it can come as part of details under the value of the sap-message header, or as error detail in an error response based on the calls taken by the developer.

Parameters:

messageKey - messageKey associated with the message, used as the key to a properties file to retrieve the message text.

target - Target for which this message applies.

params - Parameters which will be substituted in the messageText in place of placeholders.

addInfoMessage

void addInfoMessage(String messageKey,
                    String target,
                    Object... params)

Adds a (non-leading)message with severity info. The message text of the message will be obtained from a properties file based on the messageKey parameter. The messageKey parameter also becomes the "code" of the message. Parameters is taken through a variable length array of objects. These objects will be stringified and substituted in the messageText in place of parameter place holders. In case there are no parameters, just don't pass any objects for this argument. Once the message is added to the container by calling this api, it can come as part of details under the value of the sap-message header, or as error detail in an error response based on the calls taken by the developer.

Parameters:

messageKey - messageKey associated with the message, used as the key to a properties file to retrieve the message text.

target - Target for which this message applies.

params - Parameters which will be substituted in the messageText in place of placeholders.

addSuccessMessage

void addSuccessMessage(String messageKey,
                       String target,
                       Object... params)

Adds a (non-leading)message with severity success. The message text of the message will be obtained from a properties file based on the messageKey parameter. The messageKey parameter also becomes the "code" of the message. Parameters is taken through a variable length array of objects. These objects will be stringified and substituted in the messageText in place of parameter place holders. In case there are no parameters, don't pass any objects for this argument. Once the message is added to the container by calling this api, it can come as part of details under the value of the sap-message header, or as error detail in an error response based on the calls taken by the developer.

Parameters:

messageKey - messageKey associated with the message, used as the key to a properties file to retrieve the message text.

target - Target for which this message applies.

params - Parameters which will be substituted in the messageText in place of placeholders.