org.odpi.openmetadata.accessservices.communityprofile.ffdc.exceptions

Class InvalidParameterException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.odpi.openmetadata.accessservices.communityprofile.ffdc.exceptions.CommunityProfileCheckedExceptionBase

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

All Implemented Interfaces:

Serializable

public class InvalidParameterException
extends CommunityProfileCheckedExceptionBase

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
InvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, String parameterName) This is the typical constructor used for creating an exception.
InvalidParameterException(int httpCode, String className, String actionDescription, String errorMessage, String systemAction, String userAction, Throwable caughtError, String parameterName) This is the constructor used for creating an exception that resulted from a previous error.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Return comparison result based on the content of the properties.
String	getParameterName() Return the invalid parameter's name, if known.
int	hashCode() Return hash code for this object
String	toString() JSON-style toString

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.ffdc.exceptions.CommunityProfileCheckedExceptionBase

getErrorMessage, getReportedCaughtException, getReportedHTTPCode, getReportedSystemAction, getReportedUserAction, getReportingActionDescription, getReportingClassName

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 Detail

InvalidParameterException

public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 String parameterName)

This is the typical constructor used for creating an exception.

Parameters:

httpCode - http response code to use if this exception flows over a rest call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

parameterName - name of the invalid parameter if known

InvalidParameterException

public InvalidParameterException(int httpCode,
                                 String className,
                                 String actionDescription,
                                 String errorMessage,
                                 String systemAction,
                                 String userAction,
                                 Throwable caughtError,
                                 String parameterName)

This is the constructor used for creating an exception that resulted from a previous error.

Parameters:

httpCode - http response code to use if this exception flows over a rest call

className - name of class reporting error

actionDescription - description of function it was performing when error detected

errorMessage - description of error

systemAction - actions of the system as a result of the error

userAction - instructions for correcting the error

caughtError - the error that resulted in this exception.

parameterName - name of the invalid parameter if known

Method Detail

getParameterName

public String getParameterName()

Return the invalid parameter's name, if known.

Returns:

string name

toString

public String toString()

JSON-style toString

Overrides:

toString in class Throwable

Returns:

string of property names and values for this enum

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class CommunityProfileCheckedExceptionBase

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class CommunityProfileCheckedExceptionBase

Returns:

int hash code