Package 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, FFDCResponse, GenericResponse<R>

public class SubjectAreaOMASAPIResponse<R>
extends FFDCResponseBase
implements GenericResponse<R>

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubjectAreaOMASAPIResponse()

Method Summary

Modifier and Type	Method	Description
void	addAllResults(Collection<? extends R> results)	Add several results for the response
void	addResult(R result)	Add single result for the response
List<R>	results()	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

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 Details

SubjectAreaOMASAPIResponse

public SubjectAreaOMASAPIResponse()

Method Details

addAllResults

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

Description copied from interface: GenericResponse

Add several results for the response

Specified by:

addAllResults in interface GenericResponse<R>

Parameters:

results - collection with results

addResult

public void addResult(R result)

Description copied from interface: GenericResponse

Add single result for the response

Specified by:

addResult in interface GenericResponse<R>

Parameters:

result - - 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.

results

public List<R> results()

Description copied from interface: GenericResponse

Get all results of the response

Specified by:

results in interface GenericResponse<R>

Returns:

results