Package org.odpi.openmetadata.repositoryservices.rest.properties

Class EntitySummaryResponse

java.lang.Object

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse

org.odpi.openmetadata.repositoryservices.rest.properties.EntitySummaryResponse

All Implemented Interfaces:

Serializable

public class EntitySummaryResponse
extends OMRSAPIResponse

EntitySummaryResponse describes the response structure for an OMRS REST API that returns an EntitySummary object.

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse

actionDescription, exceptionCausedBy, exceptionClassName, exceptionErrorMessage, exceptionErrorMessageId, exceptionErrorMessageParameters, exceptionProperties, exceptionSystemAction, exceptionUserAction, relatedHTTPCode

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
EntitySummary	getEntity()	Return the resulting entity object.
int	hashCode()	Create a hash code for this element type.
void	setEntity(EntitySummary entity)	Set up the resulting entity object.
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse

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

EntitySummaryResponse

public EntitySummaryResponse()

Default constructor

EntitySummaryResponse

public EntitySummaryResponse(EntitySummaryResponse template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getEntity

public EntitySummary getEntity()

Return the resulting entity object.

Returns:

entity object

setEntity

public void setEntity(EntitySummary entity)

Set up the resulting entity object.

Parameters:

entity - entity object

toString

public String toString()

Standard toString method.

Overrides:

toString in class OMRSAPIResponse

Returns:

print out of variables in a JSON-style

equals

public boolean equals(Object objectToCompare)

Compare the values of the supplied object with those stored in the current object.

Overrides:

equals in class OMRSAPIResponse

Parameters:

objectToCompare - supplied object

Returns:

boolean result of comparison

hashCode

public int hashCode()

Create a hash code for this element type.

Overrides:

hashCode in class OMRSAPIResponse

Returns:

int hash code