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

Class FindRequestBody

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.FindRequestBody

public class FindRequestBody
extends ResultsRequestBody

FindRequestBody provides a structure for passing the properties for the find request.

Constructor Summary

Constructors

Constructor	Description
FindRequestBody()	Default constructor
FindRequestBody(QueryOptions template)	Copy/clone constructor
FindRequestBody(FindRequestBody 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.
SearchClassifications	getMatchClassifications()	Return details about the classifications that need to be present/absent from the search request.
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	setMatchClassifications(SearchClassifications matchClassifications)	Set up details about the classifications that need to be present/absent from the search request.
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

FindRequestBody

public FindRequestBody()

Default constructor

FindRequestBody

public FindRequestBody(FindRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

FindRequestBody

public FindRequestBody(QueryOptions template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

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

getMatchClassifications

public SearchClassifications getMatchClassifications()

Return details about the classifications that need to be present/absent from the search request.

Returns:

classification specification

setMatchClassifications

public void setMatchClassifications(SearchClassifications matchClassifications)

Set up details about the classifications that need to be present/absent from the search request.

Parameters:

matchClassifications - classification 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