org.odpi.openmetadata.commonservices.ffdc.rest

Interface FFDCResponse

All Known Subinterfaces:

GenericResponse<R>

All Known Implementing Classes:

BooleanResponse, ConnectionResponse, ConnectorTypeResponse, CountResponse, FFDCResponseBase, GUIDListResponse, GUIDResponse, NameListResponse, PropertiesResponse, RegisteredOMAGServicesResponse, StringMapResponse, StringResponse, VoidResponse

public interface FFDCResponse

Method Summary

Modifier and Type	Method and Description
String	getActionDescription() Return the description of the action in progress when the exception occurred.
String	getExceptionCausedBy() Return the name of any nested exception that may indicate the root cause of the exception.
String	getExceptionClassName() Return the name of the Java class name to use to recreate the exception.
String	getExceptionErrorMessage() Return the error message associated with the exception.
String	getExceptionErrorMessageId() Return the formal message identifier for the error message.
String[]	getExceptionErrorMessageParameters() Return the parameters that were inserted in the error message.
Map<String,Object>	getExceptionProperties() Return the additional properties stored by the exceptions.
String	getExceptionSystemAction() Return the description of the action taken by the system as a result of the exception.
String	getExceptionUserAction() Return the action that a user should take to resolve the problem.
int	getRelatedHTTPCode() Return the HTTP Code to use if forwarding response to HTTP client.
void	setActionDescription(String actionDescription) Set up the description of the activity in progress when the exception occurred.
void	setExceptionCausedBy(String exceptionCausedBy) Set up the name of any nested exception that may indicate the root cause of the exception.
void	setExceptionClassName(String exceptionClassName) Set up the name of the Java class name to use to recreate the exception.
void	setExceptionErrorMessage(String exceptionErrorMessage) Set up the error message associated with the exception.
void	setExceptionErrorMessageId(String exceptionErrorMessageId) Set up the formal message identifier for the error message.
void	setExceptionErrorMessageParameters(String[] exceptionErrorMessageParameters) Set up the list of parameters inserted in to the error message.
void	setExceptionProperties(Map<String,Object> exceptionProperties) Set up the additional properties stored by the exceptions.
void	setExceptionSystemAction(String exceptionSystemAction) Set up the description of the action taken by the system as a result of the exception.
void	setExceptionUserAction(String exceptionUserAction) Set up the action that a user should take to resolve the problem.
void	setRelatedHTTPCode(int relatedHTTPCode) Set up the HTTP Code to use if forwarding response to HTTP client.

Method Detail

getRelatedHTTPCode

int getRelatedHTTPCode()

Return the HTTP Code to use if forwarding response to HTTP client.

Returns:

integer HTTP status code

getExceptionClassName

String getExceptionClassName()

Return the name of the Java class name to use to recreate the exception.

Returns:

String name of the fully-qualified java class name

getExceptionCausedBy

String getExceptionCausedBy()

Return the name of any nested exception that may indicate the root cause of the exception.

Returns:

exception class name

getActionDescription

String getActionDescription()

Return the description of the action in progress when the exception occurred.

Returns:

string description

getExceptionErrorMessage

String getExceptionErrorMessage()

Return the error message associated with the exception.

Returns:

string error message

getExceptionErrorMessageId

String getExceptionErrorMessageId()

Return the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.

Returns:

string identifier

getExceptionErrorMessageParameters

String[] getExceptionErrorMessageParameters()

Return the parameters that were inserted in the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.

Returns:

list of strings

getExceptionSystemAction

String getExceptionSystemAction()

Return the description of the action taken by the system as a result of the exception.

Returns:

- string description of the action taken

getExceptionUserAction

String getExceptionUserAction()

Return the action that a user should take to resolve the problem.

Returns:

string instructions

getExceptionProperties

Map<String,Object> getExceptionProperties()

Return the additional properties stored by the exceptions.

Returns:

property map

setRelatedHTTPCode

void setRelatedHTTPCode(int relatedHTTPCode)

Set up the HTTP Code to use if forwarding response to HTTP client.

Parameters:

relatedHTTPCode - - integer HTTP status code

setExceptionClassName

void setExceptionClassName(String exceptionClassName)

Set up the name of the Java class name to use to recreate the exception.

Parameters:

exceptionClassName - - String name of the fully-qualified java class name

setExceptionCausedBy

void setExceptionCausedBy(String exceptionCausedBy)

Set up the name of any nested exception that may indicate the root cause of the exception.

Parameters:

exceptionCausedBy - exception class name

setActionDescription

void setActionDescription(String actionDescription)

Set up the description of the activity in progress when the exception occurred.

Parameters:

actionDescription - string description

setExceptionErrorMessage

void setExceptionErrorMessage(String exceptionErrorMessage)

Set up the error message associated with the exception.

Parameters:

exceptionErrorMessage - - string error message

setExceptionErrorMessageId

void setExceptionErrorMessageId(String exceptionErrorMessageId)

Set up the formal message identifier for the error message. This is incorporated in the error message. This is provided both for automated processing and to enable the error message to be reformatted in a different language.

Parameters:

exceptionErrorMessageId - string identifier

setExceptionErrorMessageParameters

void setExceptionErrorMessageParameters(String[] exceptionErrorMessageParameters)

Set up the list of parameters inserted in to the error message. These are provided both for automated processing and to enable the error message to be reformatted in a different language.

Parameters:

exceptionErrorMessageParameters - list of strings

setExceptionSystemAction

void setExceptionSystemAction(String exceptionSystemAction)

Set up the description of the action taken by the system as a result of the exception.

Parameters:

exceptionSystemAction - - string description of the action taken

setExceptionUserAction

void setExceptionUserAction(String exceptionUserAction)

Set up the action that a user should take to resolve the problem.

Parameters:

exceptionUserAction - - string instructions

setExceptionProperties

void setExceptionProperties(Map<String,Object> exceptionProperties)

Set up the additional properties stored by the exceptions.

Parameters:

exceptionProperties - property map