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

Class MessageContainerImpl

java.lang.Object

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

All Implemented Interfaces:

MessageContainer

public class MessageContainerImpl
extends Object
implements MessageContainer

Constructor Summary

Constructors

Constructor and Description
MessageContainerImpl(Locale locale)

Method Summary

Modifier and Type	Method and Description
void	addErrorMessage(String code, String target, Object... params) Adds a (non-leading)message with severity error.
void	addInfoMessage(String code, String target, Object... params) Adds a (non-leading)message with severity info.
void	addSuccessMessage(String code, String target, Object... params) Adds a (non-leading)message with severity success.
void	addWarningMessage(String code, String target, Object... params) Adds a (non-leading)message with severity warning.
Message	getLeadingMessage()
static String	getLocalizedMessage(String code, Object... params)
List<Message>	getMessageDetails()
void	setLeadingMessage(String code, String target, Object... params) Sets the leading message.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MessageContainerImpl

public MessageContainerImpl(Locale locale)

Method Detail

addInfoMessage

public void addInfoMessage(String code,
                           String target,
                           Object... params)

Description copied from interface: MessageContainer

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.

Specified by:

addInfoMessage in interface MessageContainer

Parameters:

code - 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

public void addWarningMessage(String code,
                              String target,
                              Object... params)

Description copied from interface: MessageContainer

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.

Specified by:

addWarningMessage in interface MessageContainer

Parameters:

code - 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.

addErrorMessage

public void addErrorMessage(String code,
                            String target,
                            Object... params)

Description copied from interface: MessageContainer

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.

Specified by:

addErrorMessage in interface MessageContainer

Parameters:

code - 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

public void setLeadingMessage(String code,
                              String target,
                              Object... params)

Description copied from interface: MessageContainer

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.

Specified by:

setLeadingMessage in interface MessageContainer

Parameters:

code - 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.

getMessageDetails

public List<Message> getMessageDetails()

getLeadingMessage

public Message getLeadingMessage()

addSuccessMessage

public void addSuccessMessage(String code,
                              String target,
                              Object... params)

Description copied from interface: MessageContainer

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.

Specified by:

addSuccessMessage in interface MessageContainer

Parameters:

code - 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.

getLocalizedMessage

public static String getLocalizedMessage(String code,
                                         Object... params)