org.odpi.openmetadata.accessservices.subjectarea.responses

Class SubjectAreaOMASAPIResponse

java.lang.Object

org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse

Direct Known Subclasses:

AntonymRelationshipResponse, CategoriesResponse, CategoryAnchorRelationshipResponse, CategoryResponse, ClassificationExceptionResponse, EntityNotDeletedExceptionResponse, EntityNotPurgedExceptionResponse, FunctionNotSupportedExceptionResponse, GlossariesResponse, GlossaryResponse, GraphResponse, InvalidParameterExceptionResponse, LibraryCategoryReferenceResponse, LibraryTermReferenceResponse, LinesResponse, MetadataServerUncontactableExceptionResponse, PreferredTermRelationshipResponse, ProjectResponse, ProjectScopeRelationshipResponse, ProjectsResponse, PropertyServerExceptionResponse, RelatedTermResponse, RelationshipNotDeletedExceptionResponse, RelationshipNotPurgedExceptionResponse, ReplacementRelationshipResponse, SemanticAssignementRelationshipResponse, StatusNotsupportedExceptionResponse, SubjectAreaDefinitionResponse, SubjectAreaDefinitionsResponse, SynonymRelationshipResponse, TermAnchorRelationshipResponse, TermCategorizationRelationshipResponse, TermHASARelationshipResponse, TermHASARelationshipResponse.UsedInContextResponse, TermISARelationshipResponse, TermISATYPEOFRelationshipResponse, TermResponse, TermsResponse, TermTYPEDBYRelationshipResponse, TranslationRelationshipResponse, UnexpectedExceptionResponse, UnrecognizedGUIDExceptionResponse, UsedInContextRelationshipResponse, UserNotAuthorizedExceptionResponse, ValidValueRelationshipResponse, VoidResponse

public abstract class SubjectAreaOMASAPIResponse
extends Object

SubjectAreaOMASAPIResponse provides a common header for Subject Area OMAS managed rest to its REST API. It manages information about exceptions. If no exception has been raised exceptionClassName is null.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	actionDescription
protected String	className
protected String	formattedMessage
protected String	messageId
protected int	relatedHTTPCode
protected ResponseCategory	responseCategory

Constructor Summary

Constructors

Constructor and Description
SubjectAreaOMASAPIResponse() Default constructor
SubjectAreaOMASAPIResponse(SubjectAreaCheckedException e) Constructor taking an Exception

Method Summary

Modifier and Type	Method and Description
String	getActionDescription() Return the description of the action that was being issued when the exception occurred.
String	getExceptionClassName() Return the name of the Java class name to use to recreate the exception.
String	getMessage() These Exceptions are include in Exception rest responses.
String	getMessageId() Return the message id; the unique identifier of the message
int	getRelatedHTTPCode() Return the HTTP Code to use if forwarding response to HTTP client.
ResponseCategory	getResponseCategory()
void	setActionDescription(String actionDescription) Set up the description of the action that was being issued when the exception occurred.
void	setExceptionClassName(String exceptionClassName) Set up the name of the Java class name to use to recreate the exception.
void	setMessageId(String messageId) Set up the message id; the unique identifier of the message
void	setResponseCategory(ResponseCategory responseCategory)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

relatedHTTPCode

protected int relatedHTTPCode

responseCategory

protected ResponseCategory responseCategory

messageId

protected String messageId

className

protected String className

actionDescription

protected String actionDescription

formattedMessage

protected String formattedMessage

Constructor Detail

SubjectAreaOMASAPIResponse

public SubjectAreaOMASAPIResponse()

Default constructor

SubjectAreaOMASAPIResponse

public SubjectAreaOMASAPIResponse(SubjectAreaCheckedException e)

Constructor taking an Exception

Parameters:

e - subject area exception

Method Detail

getRelatedHTTPCode

public int getRelatedHTTPCode()

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

Returns:

integer HTTP status code

getResponseCategory

public ResponseCategory getResponseCategory()

setResponseCategory

public void setResponseCategory(ResponseCategory responseCategory)

toString

public String toString()

Overrides:

toString in class Object

getExceptionClassName

public 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

setExceptionClassName

public 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

getActionDescription

public String getActionDescription()

Return the description of the action that was being issued when the exception occurred.

Returns:

String action description

setActionDescription

public void setActionDescription(String actionDescription)

Set up the description of the action that was being issued when the exception occurred.

Parameters:

actionDescription - String action description

getMessageId

public String getMessageId()

Return the message id; the unique identifier of the message

Returns:

String message id

getMessage

public String getMessage()

These Exceptions are include in Exception rest responses. This is useful for callers of the Rest API that are not using Java; as this would be the only way for them to see the complete message.

Returns:

formatted Message

setMessageId

public void setMessageId(String messageId)

Set up the message id; the unique identifier of the message

Parameters:

messageId - String messageId