ODFOMASAPIResponse (Discovery Engine OMAS API 3.4 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
- - org.odpi.openmetadata.accessservices.discoveryengine.rest.ODFOMASAPIResponse

All Implemented Interfaces:

Serializable, FFDCResponse

Direct Known Subclasses:

AnnotationListResponse, AnnotationResponse, DataFieldListResponse, DataFieldResponse, DiscoveryAnalysisReportListResponse, DiscoveryAnalysisReportResponse, DiscoveryEngineListResponse, DiscoveryEnginePropertiesResponse, DiscoveryRequestStatusResponse, DiscoveryServiceListResponse, DiscoveryServicePropertiesResponse, RegisteredDiscoveryServiceResponse
```
public abstract class ODFOMASAPIResponse
extends FFDCResponseBase
```
ODFOMASAPIResponse provides a common header for or Open Discovery Framework (ODF) bean-based REST responses. It manages information about exceptions. If no exception has been raised exceptionClassName is null.

See Also:

Serialized Form

- Constructor Summary
  
  Constructors
  Constructor Description
  
  ODFOMASAPIResponse()
  Default constructor
  
  ODFOMASAPIResponse(ODFOMASAPIResponse template)
  Copy/clone constructor
- Method Summary
  
  All Methods Instance Methods Concrete Methods
  Modifier and Type Method Description
  
  String toString()
  JSON-like toString
  - Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
    equals, getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, hashCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode
  - Methods inherited from class java.lang.Object
    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ODFOMASAPIResponse
```
public ODFOMASAPIResponse()
```
    Default constructor
  - ODFOMASAPIResponse
```
public ODFOMASAPIResponse(ODFOMASAPIResponse template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - toString
```
public String toString()
```
    JSON-like toString
    
    Overrides:
    
    toString in class FFDCResponseBase
    
    Returns:
    
    string containing the property names and values