Class FindRequestBody
java.lang.Object
org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
org.odpi.openmetadata.frameworkservices.gaf.rest.FindRequestBody
FindRequestBody provides a structure for passing the properties for the find request.
-
Constructor Summary
ConstructorDescriptionDefault constructorFindRequestBody
(FindRequestBody template) Copy/clone constructor -
Method Summary
Modifier and TypeMethodDescriptionboolean
Equals method that returns true if containing properties are the same.Return details about the classifications that need to be present/absent from the search request.Return the list of valid subtypes that the returned metadata elements must belong to.Return the type of metadata element that the caller is searching for.Return the details of the property values that must be true for the returned metadata elements.int
hashCode()
Return hash code for this objectvoid
setMatchClassifications
(SearchClassifications matchClassifications) Set up details about the classifications that need to be present/absent from the search request.void
setMetadataElementSubtypeNames
(List<String> metadataElementSubtypeNames) Set up the list of valid subtypes that the returned metadata elements must belong to.void
setMetadataElementTypeName
(String metadataElementTypeName) Set up the type of metadata element 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.toString()
JSON-style toString.Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody
getAsOfTime, getEffectiveTime, getLimitResultsByStatus, getSequencingOrder, getSequencingProperty, setAsOfTime, setEffectiveTime, setLimitResultsByStatus, setSequencingOrder, setSequencingProperty
-
Constructor Details
-
FindRequestBody
public FindRequestBody()Default constructor -
FindRequestBody
Copy/clone constructor- Parameters:
template
- object to copy
-
-
Method Details
-
getMetadataElementTypeName
Return the type of metadata element that the caller is searching for.- Returns:
- open metadata type name
-
setMetadataElementTypeName
Set up the type of metadata element that the caller is searching for.- Parameters:
metadataElementTypeName
- open metadata type name
-
getMetadataElementSubtypeNames
Return the list of valid subtypes that the returned metadata elements must belong to.- Returns:
- open metadata type names
-
setMetadataElementSubtypeNames
Set up the list of valid subtypes that the returned metadata elements must belong to.- Parameters:
metadataElementSubtypeNames
- open metadata type names
-
getSearchProperties
Return the details of the property values that must be true for the returned metadata elements.- Returns:
- property specification
-
setSearchProperties
Set up the details of the property values that must be true for the returned metadata elements.- Parameters:
searchProperties
- property specification
-
getMatchClassifications
Return details about the classifications that need to be present/absent from the search request.- Returns:
- classification specification
-
setMatchClassifications
Set up details about the classifications that need to be present/absent from the search request.- Parameters:
matchClassifications
- classification specification
-
toString
JSON-style toString.- Overrides:
toString
in classResultsRequestBody
- Returns:
- list of properties and their values.
-
equals
Equals method that returns true if containing properties are the same.- Overrides:
equals
in classResultsRequestBody
- Parameters:
objectToCompare
- object to compare- Returns:
- boolean result of comparison
-
hashCode
public int hashCode()Return hash code for this object- Overrides:
hashCode
in classResultsRequestBody
- Returns:
- int hash code
-