Class APIResponse
- java.lang.Object
-
- org.odpi.openmetadata.commonservices.ffdc.rest.FFDCResponseBase
-
- org.odpi.openmetadata.accessservices.datamanager.rest.DataManagerOMASAPIResponse
-
- org.odpi.openmetadata.accessservices.datamanager.rest.APIResponse
-
- All Implemented Interfaces:
Serializable
,FFDCResponse
public class APIResponse extends DataManagerOMASAPIResponse
APIResponse is a response object for passing back a single API element or an exception if the request failed.- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description APIResponse()
Default constructorAPIResponse(APIResponse template)
Copy/clone constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
equals(Object objectToCompare)
Return comparison result based on the content of the properties.APIElement
getElement()
Return the metadata element.int
hashCode()
Return hash code for this objectvoid
setElement(APIElement 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
-
-
-
-
Constructor Detail
-
APIResponse
public APIResponse()
Default constructor
-
APIResponse
public APIResponse(APIResponse template)
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Detail
-
getElement
public APIElement getElement()
Return the metadata element.- Returns:
- result object
-
setElement
public void setElement(APIElement element)
Set up the metadata element to return.- Parameters:
element
- result object
-
toString
public String toString()
JSON-style toString- Overrides:
toString
in classDataManagerOMASAPIResponse
- 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 classFFDCResponseBase
- Parameters:
objectToCompare
- test object- Returns:
- result of comparison
-
hashCode
public int hashCode()
Return hash code for this object- Overrides:
hashCode
in classFFDCResponseBase
- Returns:
- int hash code
-
-