OMRSAPIResponse (Repository Services General APIs 1.2 API)

java.lang.Object
- org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AttributeTypeDefListResponse, AttributeTypeDefResponse, BooleanResponse, CohortMembershipResponse, EntityDetailResponse, EntitySummaryResponse, InstanceGraphResponse, MetadataCollectionIdResponse, OMRSAPIPagedResponse, RelationshipResponse, TypeDefGalleryResponse, TypeDefListResponse, TypeDefResponse, VoidResponse
```
public abstract class OMRSAPIResponse
extends Object
implements Serializable
```
OMRSRESTAPIResponse provides a common header for OMRS managed rest to the OMRS REST API. It manages information about OMRS exceptions. If no exception has been raised exceptionClassName is null.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`exceptionClassName`
`protected String`	`exceptionErrorMessage`
`protected Map<String,Object>`	`exceptionProperties`
`protected String`	`exceptionSystemAction`
`protected String`	`exceptionUserAction`
`protected int`	`relatedHTTPCode`

Constructor Summary

Constructors
Constructor and Description

OMRSAPIResponse()
Default constructor

OMRSAPIResponse(OMRSAPIResponse template)
Copy/clone constructor

Constructors
Constructor and Description
`OMRSAPIResponse()` Default constructor
`OMRSAPIResponse(OMRSAPIResponse template)` Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Compare the values of the supplied object with those stored in the current object.
`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.
`Map<String,Object>`	`getExceptionProperties()` Return any additional properties associated with the exception.
`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.
`int`	`hashCode()` Create a hash code for this element type.
`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`	`setExceptionProperties(Map<String,Object> exceptionProperties)` Set up any additional properties associated with the exception.
`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.
`String`	`toString()` Standard toString method.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - relatedHTTPCode
```
protected int relatedHTTPCode
```
  - exceptionClassName
```
protected String exceptionClassName
```
  - exceptionErrorMessage
```
protected String exceptionErrorMessage
```
  - exceptionSystemAction
```
protected String exceptionSystemAction
```
  - exceptionUserAction
```
protected String exceptionUserAction
```
  - exceptionProperties
```
protected Map<String,Object> exceptionProperties
```
- Constructor Detail
  - OMRSAPIResponse
```
public OMRSAPIResponse()
```
    Default constructor
  - OMRSAPIResponse
```
public OMRSAPIResponse(OMRSAPIResponse template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getRelatedHTTPCode
```
public int getRelatedHTTPCode()
```
    Return the HTTP Code to use if forwarding response to HTTP client.
    
    Returns:
    
    integer HTTP status code
  - setRelatedHTTPCode
```
public void setRelatedHTTPCode(int relatedHTTPCode)
```
    Set up the HTTP Code to use if forwarding response to HTTP client.
    
    Parameters:
    
    relatedHTTPCode - integer HTTP status code
  - 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
  - getExceptionErrorMessage
```
public String getExceptionErrorMessage()
```
    Return the error message associated with the exception.
    
    Returns:
    
    string error message
  - setExceptionErrorMessage
```
public void setExceptionErrorMessage(String exceptionErrorMessage)
```
    Set up the error message associated with the exception.
    
    Parameters:
    
    exceptionErrorMessage - string error message
  - getExceptionSystemAction
```
public 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
  - setExceptionSystemAction
```
public 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
  - getExceptionUserAction
```
public String getExceptionUserAction()
```
    Return the action that a user should take to resolve the problem.
    
    Returns:
    
    string instructions
  - setExceptionUserAction
```
public void setExceptionUserAction(String exceptionUserAction)
```
    Set up the action that a user should take to resolve the problem.
    
    Parameters:
    
    exceptionUserAction - string instructions
  - getExceptionProperties
```
public Map<String,Object> getExceptionProperties()
```
    Return any additional properties associated with the exception.
    
    Returns:
    
    map of properties
  - setExceptionProperties
```
public void setExceptionProperties(Map<String,Object> exceptionProperties)
```
    Set up any additional properties associated with the exception.
    
    Parameters:
    
    exceptionProperties - map of name value pairs
  - toString
```
public String toString()
```
    Standard toString method.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    print out of variables in a JSON-style
  - equals
```
public boolean equals(Object objectToCompare)
```
    Compare the values of the supplied object with those stored in the current object.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    
    objectToCompare - supplied object
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Create a hash code for this element type.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int hash code

Class OMRSAPIResponse

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

relatedHTTPCode

exceptionClassName

exceptionErrorMessage

exceptionSystemAction

exceptionUserAction

exceptionProperties

Constructor Detail

OMRSAPIResponse

OMRSAPIResponse

Method Detail

getRelatedHTTPCode

setRelatedHTTPCode

getExceptionClassName

setExceptionClassName

getExceptionErrorMessage

setExceptionErrorMessage

getExceptionSystemAction

setExceptionSystemAction

getExceptionUserAction

setExceptionUserAction

getExceptionProperties

setExceptionProperties

toString

equals

hashCode