org.odpi.openmetadata.repositoryservices.rest.properties

Class RelationshipListResponse

java.lang.Object

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

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedResponse

org.odpi.openmetadata.repositoryservices.rest.properties.RelationshipListResponse

All Implemented Interfaces:

Serializable

public class RelationshipListResponse
extends OMRSAPIPagedResponse

RelationshipListResponse holds the response information for an OMRS REST API call that returns a list of relationship objects or an exception.

See Also:

Serialized Form

Field Summary

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

nextPageURL, offset, pageSize

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

exceptionClassName, exceptionErrorMessage, exceptionProperties, exceptionSystemAction, exceptionUserAction, relatedHTTPCode

Constructor Summary

Constructors

Constructor and Description
RelationshipListResponse() Default constructor
RelationshipListResponse(RelationshipListResponse template) Copy/clone constructor

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object objectToCompare) Compare the values of the supplied object with those stored in the current object.
List<Relationship>	getRelationships() Return the list of relationships for this response.
int	hashCode() Create a hash code for this element type.
void	setRelationships(List<Relationship> relationships) Set up the list of relationships for this response.
String	toString() Standard toString method.

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

getNextPageURL, getOffset, getPageSize, setNextPageURL, setOffset, setPageSize

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

getExceptionClassName, getExceptionErrorMessage, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setExceptionClassName, setExceptionErrorMessage, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RelationshipListResponse

public RelationshipListResponse()

Default constructor

RelationshipListResponse

public RelationshipListResponse(RelationshipListResponse template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getRelationships

public List<Relationship> getRelationships()

Return the list of relationships for this response.

Returns:

list of relationship objects

setRelationships

public void setRelationships(List<Relationship> relationships)

Set up the list of relationships for this response.

Parameters:

relationships - list of relationship objects

toString

public String toString()

Standard toString method.

Overrides:

toString in class OMRSAPIPagedResponse

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 OMRSAPIPagedResponse

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 OMRSAPIPagedResponse

Returns:

int hash code