com.elasticpath.xpf.connectivity.dto

Class XPFStructuredErrorMessage

java.lang.Object

com.elasticpath.xpf.connectivity.dto.XPFStructuredErrorMessage

public class XPFStructuredErrorMessage
extends Object

Represents a commerce message data object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	XPFStructuredErrorMessage.XPFStructuredErrorMessageBuilder Structured error message builder.

Constructor Summary

Constructors

Constructor and Description
XPFStructuredErrorMessage(String messageId, String debugMessage, Map<String,String> data) Constructor to create a StructuredErrorMessage of type Error.
XPFStructuredErrorMessage(XPFStructuredErrorMessageType type, String messageId, String debugMessage, Map<String,String> data) Constructor to create a StructuredErrorMessage.
XPFStructuredErrorMessage(XPFStructuredErrorMessageType type, String messageId, String debugMessage, Map<String,String> data, XPFStructuredErrorResolution resolution) Constructor.

Method Summary

Modifier and Type	Method and Description
static XPFStructuredErrorMessage.XPFStructuredErrorMessageBuilder	builder() Builder.
boolean	equals(Object other)
Map<String,String>	getData() Get the map of additional information related to the message.
String	getDebugMessage() Get the debug message for the structured message.
String	getMessageId() Get the id of the message.
Optional<XPFStructuredErrorResolution>	getResolution()
XPFStructuredErrorMessageType	getType() Get the type of the message.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

XPFStructuredErrorMessage

public XPFStructuredErrorMessage(String messageId,
                                 String debugMessage,
                                 Map<String,String> data)

Constructor to create a StructuredErrorMessage of type Error.

Parameters:

messageId - messageId

debugMessage - debug message

data - data

XPFStructuredErrorMessage

public XPFStructuredErrorMessage(XPFStructuredErrorMessageType type,
                                 String messageId,
                                 String debugMessage,
                                 Map<String,String> data)

Constructor to create a StructuredErrorMessage.

Parameters:

type - type

messageId - messageId

debugMessage - debug message

data - data

XPFStructuredErrorMessage

public XPFStructuredErrorMessage(XPFStructuredErrorMessageType type,
                                 String messageId,
                                 String debugMessage,
                                 Map<String,String> data,
                                 XPFStructuredErrorResolution resolution)

Constructor.

Parameters:

type - type

messageId - messageId

debugMessage - debug message

data - data

resolution - resolution

Method Detail

getResolution

public Optional<XPFStructuredErrorResolution> getResolution()

getType

public XPFStructuredErrorMessageType getType()

Get the type of the message.

Returns:

the type

getMessageId

public String getMessageId()

Get the id of the message.

Returns:

message Id

getDebugMessage

public String getDebugMessage()

Get the debug message for the structured message.

Returns:

the debug message

getData

public Map<String,String> getData()

Get the map of additional information related to the message. This includes values that can be used to replace placeholders in message templates.

Returns:

the map.

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

builder

public static XPFStructuredErrorMessage.XPFStructuredErrorMessageBuilder builder()

Builder.

Returns:

structured error message builder