org.odpi.openmetadata.accessservices.subjectarea.responses

Class SubjectAreaOMASAPIResponse<R>

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

public class SubjectAreaOMASAPIResponse<R>
extends FFDCResponseBase

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SubjectAreaOMASAPIResponse()

Method Summary

Modifier and Type	Method and Description
void	addAllResults(Collection<? extends R> entities) Add several results for the response
void	addResult(R entity) Add single result for the response
R	getHead() Get head element from result array.
List<R>	getResult() Get all results of the response
void	setExceptionInfo(OCFCheckedExceptionBase e, String className) Set a standard exceptional info for the response

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SubjectAreaOMASAPIResponse

public SubjectAreaOMASAPIResponse()

Method Detail

addAllResults

public void addAllResults(Collection<? extends R> entities)

Add several results for the response

Parameters:

entities - collection with results

addResult

public void addResult(R entity)

Add single result for the response

Parameters:

entity - - one result

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.

getHead

public R getHead()

Get head element from result array. Needed when we know for sure that the answer is single object

Returns:

result

getResult

public List<R> getResult()

Get all results of the response

Returns:

results