SubjectAreaOMASAPIResponse (Subject Area OMAS api 3.5 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
- - org.odpi.openmetadata.accessservices.subjectarea.responses.SubjectAreaOMASAPIResponse<R>

Type Parameters:

R - type for response results 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.

All Implemented Interfaces:

Serializable, FFDCResponse, GenericResponse<R>
```
public class SubjectAreaOMASAPIResponse<R>
extends FFDCResponseBase
implements GenericResponse<R>
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

SubjectAreaOMASAPIResponse()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addAllResults(Collection<? extends R> results)`
`void`	`addResult(R result)`
`List<R>`	`results()`
`void`	`setExceptionInfo(OCFCheckedExceptionBase e, String className)`	Set a standard exceptional info for the response

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

Methods inherited from interface org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponse
getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

Methods inherited from interface org.odpi.openmetadata.commonservices.ffdc.rest.GenericResponse
head

- Constructor Detail
  - SubjectAreaOMASAPIResponse
```
public SubjectAreaOMASAPIResponse()
```
- Method Detail
  - addAllResults
```
public void addAllResults(Collection<? extends R> results)
```
    Specified by:
    
    addAllResults in interface GenericResponse<R>
  - addResult
```
public void addResult(R result)
```
    Specified by:
    
    addResult in interface GenericResponse<R>
  - setExceptionInfo
```
public void setExceptionInfo(OCFCheckedExceptionBase e,
                             String className)
```
    Set a standard exceptional info for the response
    
    Parameters:
    
    e - exception OCFCheckedExceptionBase
    
    className - name of the class being called.
  - results
```
public List<R> results()
```
    Specified by:
    
    results in interface GenericResponse<R>