org.odpi.openmetadata.repositoryservices.rest.properties

Class EntityNeighborhoodFindRequest

java.lang.Object

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest

org.odpi.openmetadata.repositoryservices.rest.properties.EntityNeighborhoodFindRequest

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

EntityNeighborhoodHistoricalFindRequest

public class EntityNeighborhoodFindRequest
extends OMRSAPIFindRequest

EntityNeighborhoodFindRequest adds the ability to restrict a neighborhood find request to only traversing specific relationship types.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
EntityNeighborhoodFindRequest() Default constructor
EntityNeighborhoodFindRequest(EntityNeighborhoodFindRequest 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<String>	getEntityTypeGUIDs() Return the list of entity types that should restrict the find request.
List<String>	getLimitResultsByClassification() Return the list of entity classifications that should restrict the find request.
List<String>	getRelationshipTypeGUIDs() Return the list of relationship type guids that limit the find request.
int	hashCode() Create a hash code for this element type.
void	setEntityTypeGUIDs(List<String> entityTypeGUIDs) Set up the list of entity types that should restrict the find request.
void	setLimitResultsByClassification(List<String> limitResultsByClassification) Set up the list of entity classifications that should restrict the find request.
void	setRelationshipTypeGUIDs(List<String> relationshipTypeGUIDs) Set up the list of relationship type guids that limit the find request.
String	toString() Standard toString method.

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

getLimitResultsByStatus, setLimitResultsByStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

EntityNeighborhoodFindRequest

public EntityNeighborhoodFindRequest()

Default constructor

EntityNeighborhoodFindRequest

public EntityNeighborhoodFindRequest(EntityNeighborhoodFindRequest template)

Copy/clone constructor.

Parameters:

template - object to copy

Method Detail

getEntityTypeGUIDs

public List<String> getEntityTypeGUIDs()

Return the list of entity types that should restrict the find request.

Returns:

list of guids

setEntityTypeGUIDs

public void setEntityTypeGUIDs(List<String> entityTypeGUIDs)

Set up the list of entity types that should restrict the find request.

Parameters:

entityTypeGUIDs - list of guids

getLimitResultsByClassification

public List<String> getLimitResultsByClassification()

Return the list of entity classifications that should restrict the find request.

Returns:

list of classification names

setLimitResultsByClassification

public void setLimitResultsByClassification(List<String> limitResultsByClassification)

Set up the list of entity classifications that should restrict the find request.

Parameters:

limitResultsByClassification - list of classification names

getRelationshipTypeGUIDs

public List<String> getRelationshipTypeGUIDs()

Return the list of relationship type guids that limit the find request.

Returns:

list of guids

setRelationshipTypeGUIDs

public void setRelationshipTypeGUIDs(List<String> relationshipTypeGUIDs)

Set up the list of relationship type guids that limit the find request.

Parameters:

relationshipTypeGUIDs - list of guids

toString

public String toString()

Standard toString method.

Overrides:

toString in class OMRSAPIFindRequest

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 OMRSAPIFindRequest

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 OMRSAPIFindRequest

Returns:

int hash code