de.hybris.platform.print.comet.utils

Interface CometResultMessageTools

All Known Implementing Classes:

DefaultCometResultMessageTools

public interface CometResultMessageTools

The CometResultMessageTools class handles displaying of information, warnings and errors for the result of user actions.

Method Summary

Modifier and Type	Method and Description
void	addMessage(List<String> messages) Adds a list of messages for the given session.
void	clearMessages() Clears the messages by removing the CometResultMessage from the current session.
String	getMessage(int resultCode) Returns the messages for the given session id and result code.
int	getResultCode() Returns the current result code used by the CometResultMessage for the current session.

Method Detail

addMessage

void addMessage(List<String> messages)

Adds a list of messages for the given session. The messages should already be correctly localized.

Parameters:

messages - a list of already localized string

clearMessages

void clearMessages()

Clears the messages by removing the CometResultMessage from the current session.

getResultCode

int getResultCode()

Returns the current result code used by the CometResultMessage for the current session.

Returns:

the current result code

getMessage

String getMessage(int resultCode)

Returns the messages for the given session id and result code. The messages are joined with a newline character and will be displayed in InDesign as information.

Parameters:

resultCode - the result code for the saved messages

Returns:

the message to be displayed in InDesign