Package org.odpi.openmetadata.frameworkservices.omf.rest

Class FindRelationshipRequestBody

java.lang.Object

org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions

org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions

org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions

org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions

org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody

org.odpi.openmetadata.frameworkservices.omf.rest.FindRelationshipRequestBody

public class FindRelationshipRequestBody
extends ResultsRequestBody

FindRelationshipRequestBody provides a structure for passing the properties for the find relationships request.

Constructor Summary

Constructors

Constructor	Description
FindRelationshipRequestBody()	Default constructor
FindRelationshipRequestBody(QueryOptions template)	Copy/clone constructor
FindRelationshipRequestBody(FindRelationshipRequestBody template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Equals method that returns true if containing properties are the same.
String	getRelationshipTypeName()	Return the type of relationship that the caller is searching for.
SearchProperties	getSearchProperties()	Return the details of the property values that must be true for the returned metadata elements.
int	hashCode()	Return hash code for this object
void	setRelationshipTypeName(String relationshipTypeName)	Set up the type of relationship that the caller is searching for.
void	setSearchProperties(SearchProperties searchProperties)	Set up the details of the property values that must be true for the returned metadata elements.
String	toString()	JSON-style toString.

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.QueryOptions

getAnchorDomainName, getAnchorGUID, getAnchorScopeGUID, getLimitResultsByStatus, getSequencingOrder, getSequencingProperty, setAnchorDomainName, setAnchorGUID, setAnchorScopeGUID, setLimitResultsByStatus, setSequencingOrder, setSequencingProperty

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.PagingOptions

getPageSize, getStartFrom, setPageSize, setStartFrom

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.GetOptions

getAsOfTime, getGraphQueryDepth, getIncludeOnlyClassifiedElements, getIncludeOnlyRelationships, getMetadataElementSubtypeNames, getMetadataElementTypeName, getRelationshipsPageSize, getSkipClassifiedElements, getSkipRelationships, setAsOfTime, setGraphQueryDepth, setIncludeOnlyClassifiedElements, setIncludeOnlyRelationships, setMetadataElementSubtypeNames, setMetadataElementTypeName, setRelationshipsPageSize, setSkipClassifiedElements, setSkipRelationships

Methods inherited from class org.odpi.openmetadata.frameworks.openmetadata.search.BasicOptions

getEffectiveTime, getForDuplicateProcessing, getForLineage, getGovernanceZoneFilter, setEffectiveTime, setForDuplicateProcessing, setForLineage, setGovernanceZoneFilter

Methods inherited from class java.lang.Object

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

Constructor Details

FindRelationshipRequestBody

public FindRelationshipRequestBody()

Default constructor

FindRelationshipRequestBody

public FindRelationshipRequestBody(FindRelationshipRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

FindRelationshipRequestBody

public FindRelationshipRequestBody(QueryOptions template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getRelationshipTypeName

public String getRelationshipTypeName()

Return the type of relationship that the caller is searching for.

Returns:

open metadata type name

setRelationshipTypeName

public void setRelationshipTypeName(String relationshipTypeName)

Set up the type of relationship that the caller is searching for.

Parameters:

relationshipTypeName - open metadata type name

getSearchProperties

public SearchProperties getSearchProperties()

Return the details of the property values that must be true for the returned metadata elements.

Returns:

property specification

setSearchProperties

public void setSearchProperties(SearchProperties searchProperties)

Set up the details of the property values that must be true for the returned metadata elements.

Parameters:

searchProperties - property specification

toString

public String toString()

JSON-style toString.

Overrides:

toString in class ResultsRequestBody

Returns:

list of properties and their values.

equals

public boolean equals(Object objectToCompare)

Equals method that returns true if containing properties are the same.

Overrides:

equals in class QueryOptions

Parameters:

objectToCompare - object to compare

Returns:

boolean result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class QueryOptions

Returns:

int hash code