Package org.odpi.openmetadata.accessservices.subjectarea.ffdc.exceptions

Class InvalidParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

org.odpi.openmetadata.accessservices.subjectarea.ffdc.exceptions.SubjectAreaCheckedException

org.odpi.openmetadata.accessservices.subjectarea.ffdc.exceptions.InvalidParameterException

All Implemented Interfaces:

Serializable

public class InvalidParameterException
extends SubjectAreaCheckedException

The InvalidParameterException is thrown by the Subject Area OMAS when a parameter is null or an invalid value.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
InvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, String invalidPropertyName, String invalidPropertyValue)	This is the constructor used for creating an InvalidParameterException when an unexpected error has been caught.
InvalidParameterException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, String invalidPropertyName, String invalidPropertyValue)	This is the typical constructor used for creating an InvalidParameterException

Method Summary

Modifier and Type	Method	Description
String	getInvalidPropertyName()	invalid property name
String	getInvalidPropertyValue()	invalid property value
Map<String,Object>	getRelatedProperties()	Return any additional properties that were added to the exception to aid diagnosis.
void	setRelatedProperties(Map<String,Object> relatedProperties)

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.exceptions.OMAGCheckedExceptionBase

toString

Methods inherited from class org.odpi.openmetadata.frameworks.connectors.ffdc.OCFCheckedExceptionBase

equals, getErrorMessage, getReportedCaughtException, getReportedCaughtExceptionClassName, getReportedErrorMessage, getReportedErrorMessageId, getReportedErrorMessageParameters, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName, hashCode

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

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

Constructor Details

InvalidParameterException

public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 String invalidPropertyName,
 String invalidPropertyValue)

This is the typical constructor used for creating an InvalidParameterException

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

invalidPropertyName - invalidPropertyName if there is one

invalidPropertyValue - invalidPropertyValue if there is one

InvalidParameterException

public InvalidParameterException(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 Exception caughtError,
 String invalidPropertyName,
 String invalidPropertyValue)

This is the constructor used for creating an InvalidParameterException when an unexpected error has been caught. The properties allow additional information to be associated with the exception.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

caughtError - previous error causing this exception

invalidPropertyName - invalidPropertyName if there is one

invalidPropertyValue - invalidPropertyValue if there is one

Method Details

getInvalidPropertyName

public String getInvalidPropertyName()

invalid property name

Returns:

invalid property name

getInvalidPropertyValue

public String getInvalidPropertyValue()

invalid property value

Returns:

in valid property value

getRelatedProperties

public Map<String,Object> getRelatedProperties()

Description copied from class: OCFCheckedExceptionBase

Return any additional properties that were added to the exception to aid diagnosis.

Overrides:

getRelatedProperties in class OCFCheckedExceptionBase

Returns:

property map

setRelatedProperties

public void setRelatedProperties(Map<String,Object> relatedProperties)