Package org.chenile.base.response

Interface WarningAware

All Known Implementing Classes:

ChenileExchange, GenericResponse

public interface WarningAware

Extract and set warnings to response objects (either objects or maps)

It allows for checking of warnings to objects and also to add warnings to objects which are capable of accommodating warnings.

Currently, all objects capable of accommodating warnings will either implement this interface or be a map (in which case a warningMessages key is created in the map)

Author:

Raja Shankar Kolluru

Field Summary

Fields

Modifier and Type	Field	Description
static final String	WARNING_MESSAGES_KEY

Method Summary

Modifier and Type	Method	Description
static void	addWarningMessage(Object data, ResponseMessage message)	Adds a warning message to the context.
void	addWarningMessage(ResponseMessage m)
static void	addWarningMessages(Object data, List<ResponseMessage> warnings)
List<ResponseMessage>	getWarningMessages()
static List<ResponseMessage>	obtainWarnings(Object data)
void	removeAllWarnings()
static void	removeAllWarnings(Object data)

Field Details

WARNING_MESSAGES_KEY

static final String WARNING_MESSAGES_KEY

See Also:

• Constant Field Values

Method Details

getWarningMessages

List<ResponseMessage> getWarningMessages()

addWarningMessage

void addWarningMessage(ResponseMessage m)

removeAllWarnings

void removeAllWarnings()

obtainWarnings

static List<ResponseMessage> obtainWarnings(Object data)

addWarningMessage

static void addWarningMessage(Object data,
 ResponseMessage message)

Adds a warning message to the context. This method can add warnings to WarningAware data types or map data types

Parameters:

data -

message -

removeAllWarnings

static void removeAllWarnings(Object data)

addWarningMessages

static void addWarningMessages(Object data,
 List<ResponseMessage> warnings)