Package org.odpi.openmetadata.commonservices.ffdc.rest

Class CollectionsResponse

java.lang.Object

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

org.odpi.openmetadata.commonservices.ffdc.rest.CollectionsResponse

All Implemented Interfaces:

FFDCResponse

public class CollectionsResponse
extends FFDCResponseBase

CollectionsResponse is the response structure used on the OMAS REST API calls that return a list of collection elements.

Constructor Summary

Constructors

Constructor	Description
CollectionsResponse()	Default constructor
CollectionsResponse(CollectionsResponse 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.
List<CollectionElement>	getElements()	Return the collection result.
int	hashCode()	Return hash code for this object
void	setElements(List<CollectionElement> elements)	Set up the collection result.
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 Details

CollectionsResponse

public CollectionsResponse()

Default constructor

CollectionsResponse

public CollectionsResponse(CollectionsResponse template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getElements

public List<CollectionElement> getElements()

Return the collection result.

Returns:

unique identifier

setElements

public void setElements(List<CollectionElement> elements)

Set up the collection result.

Parameters:

elements - - unique identifier

toString

public String toString()

JSON-style toString

Overrides:

toString in class FFDCResponseBase

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