Package org.odpi.openmetadata.accessservices.datamanager.rest

Class APIParameterResponse

java.lang.Object

org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

org.odpi.openmetadata.accessservices.datamanager.rest.DataManagerOMASAPIResponse

org.odpi.openmetadata.accessservices.datamanager.rest.APIParameterResponse

All Implemented Interfaces:

Serializable, FFDCResponse

public class APIParameterResponse
extends DataManagerOMASAPIResponse

APIParameterResponse is a response object for passing back a single APIParameter element or an exception if the request failed.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
APIParameterResponse()	Default constructor
APIParameterResponse(APIParameterResponse template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
APIParameterElement	getElement()	Return the metadata element.
int	hashCode()	Return hash code for this object
void	setElement(APIParameterElement element)	Set up the metadata element to return.
String	toString()	JSON-style toString

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase

getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, 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

APIParameterResponse

public APIParameterResponse()

Default constructor

APIParameterResponse

public APIParameterResponse(APIParameterResponse template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getElement

public APIParameterElement getElement()

Return the metadata element.

Returns:

result object

setElement

public void setElement(APIParameterElement element)

Set up the metadata element to return.

Parameters:

element - result object

toString

public String toString()

JSON-style toString

Overrides:

toString in class DataManagerOMASAPIResponse

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class FFDCResponseBase

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class FFDCResponseBase

Returns:

int hash code