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

Class SubjectAreaCheckedException

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ClassificationException, FunctionNotSupportedException, GuidOrientatedException, InvalidParameterException, MetadataServerUncontactableException, PropertyServerException, StatusNotSupportedException, UserNotAuthorizedException

public class SubjectAreaCheckedException
extends OMAGCheckedExceptionBase

SubjectAreaCheckedException provides a checked exception for reporting errors found when using the Subject Area OMAS services. Typically these errors are either configuration or operational errors that can be fixed by an administrator However, there may be the odd bug that surfaces here. The SubjectAreaErrorCode can be used with this exception to populate it with standard messages. The aim is to be able to uniquely identify the cause and remedy for the error.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription)	This is the typical constructor used for creating an SubjectAreaCheckedException.
SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError)	This is the constructor used for creating an SubjectAreaCheckedException when an unexpected error has been caught.
SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Exception caughtError, Map<String,Object> relatedProperties)	This is the constructor used for creating an SubjectAreaCheckedException when an unexpected error has been caught.
SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition, String className, String actionDescription, Map<String,Object> relatedProperties)	This is the typical constructor used for creating an SubjectAreaCheckedException.

Method Summary

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, getRelatedProperties, 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

SubjectAreaCheckedException

public SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription)

This is the typical constructor used for creating an SubjectAreaCheckedException.

Parameters:

messageDefinition - content of the message

className - name of class reporting error

actionDescription - description of function it was performing when error detected

SubjectAreaCheckedException

public SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 Map<String,Object> relatedProperties)

This is the typical constructor used for creating an SubjectAreaCheckedException. 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

relatedProperties - arbitrary properties that may help with diagnosing the problem.

SubjectAreaCheckedException

public SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 Exception caughtError)

This is the constructor used for creating an SubjectAreaCheckedException 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

SubjectAreaCheckedException

public SubjectAreaCheckedException(ExceptionMessageDefinition messageDefinition,
 String className,
 String actionDescription,
 Exception caughtError,
 Map<String,Object> relatedProperties)

This is the constructor used for creating an SubjectAreaCheckedException 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

relatedProperties - arbitrary properties that may help with diagnosing the problem.