FindRequestBody (Governance Engine OMAS API 2.11 API)

java.lang.Object
- org.odpi.openmetadata.accessservices.governanceengine.rest.FindRequestBody

All Implemented Interfaces:

Serializable
```
public class FindRequestBody
extends Object
implements Serializable
```
FindRequestBody provides a structure for passing the properties for the find request.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

FindRequestBody()
Default constructor

FindRequestBody(FindRequestBody template)
Copy/clone constructor

Constructors
Constructor and Description
`FindRequestBody()` Default constructor
`FindRequestBody(FindRequestBody template)` Copy/clone constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object objectToCompare)` Equals method that returns true if containing properties are the same.
`List<ElementStatus>`	`getLimitResultsByStatus()` Return the status values that the resulting metadata elements must match.
`SearchClassifications`	`getMatchClassifications()` Return details about the classifications that need to be present/absent from the search request.
`List<String>`	`getMetadataElementSubtypeName()` Return the list of valid subtypes that the returned metadata elements must belong to.
`String`	`getMetadataElementTypeName()` Return the type of metadata element that the caller is searching for.
`SearchProperties`	`getSearchProperties()` Return the details of the property values that must be true for the returned metadata elements.
`SequencingOrder`	`getSequencingOrder()` Return the order that the results should be returned in.
`String`	`getSequencingProperty()` Return the name of the property whose value will be used to sequence the results.
`int`	`hashCode()` Return hash code for this object
`void`	`setLimitResultsByStatus(List<ElementStatus> limitResultsByStatus)` Set up the status values that the resulting metadata elements must match.
`void`	`setMatchClassifications(SearchClassifications matchClassifications)` Set up details about the classifications that need to be present/absent from the search request.
`void`	`setMetadataElementSubtypeName(List<String> metadataElementSubtypeName)` 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.
`void`	`setSequencingOrder(SequencingOrder sequencingOrder)` Set up the order that the results should be returned in.
`void`	`setSequencingProperty(String sequencingProperty)` Set up the name of the property whose value will be used to sequence the results.
`String`	`toString()` JSON-style toString.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - FindRequestBody
```
public FindRequestBody()
```
    Default constructor
  - FindRequestBody
```
public FindRequestBody(FindRequestBody template)
```
    Copy/clone constructor
    
    Parameters:
    
    template - object to copy
- Method Detail
  - getMetadataElementTypeName
```
public String getMetadataElementTypeName()
```
    Return the type of metadata element that the caller is searching for.
    
    Returns:
    
    open metadata type name
  - setMetadataElementTypeName
```
public void setMetadataElementTypeName(String metadataElementTypeName)
```
    Set up the type of metadata element that the caller is searching for.
    
    Parameters:
    
    metadataElementTypeName - open metadata type name
  - getMetadataElementSubtypeName
```
public List<String> getMetadataElementSubtypeName()
```
    Return the list of valid subtypes that the returned metadata elements must belong to.
    
    Returns:
    
    open metadata type names
  - setMetadataElementSubtypeName
```
public void setMetadataElementSubtypeName(List<String> metadataElementSubtypeName)
```
    Set up the list of valid subtypes that the returned metadata elements must belong to.
    
    Parameters:
    
    metadataElementSubtypeName - open metadata type names
  - 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
  - getLimitResultsByStatus
```
public List<ElementStatus> getLimitResultsByStatus()
```
    Return the status values that the resulting metadata elements must match.
    
    Returns:
    
    status values
  - setLimitResultsByStatus
```
public void setLimitResultsByStatus(List<ElementStatus> limitResultsByStatus)
```
    Set up the status values that the resulting metadata elements must match.
    
    Parameters:
    
    limitResultsByStatus - status values
  - 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
  - getSequencingProperty
```
public String getSequencingProperty()
```
    Return the name of the property whose value will be used to sequence the results.
    
    Returns:
    
    property name
  - setSequencingProperty
```
public void setSequencingProperty(String sequencingProperty)
```
    Set up the name of the property whose value will be used to sequence the results.
    
    Parameters:
    
    sequencingProperty - property name
  - getSequencingOrder
```
public SequencingOrder getSequencingOrder()
```
    Return the order that the results should be returned in.
    
    Returns:
    
    enum for the sequencing order
  - setSequencingOrder
```
public void setSequencingOrder(SequencingOrder sequencingOrder)
```
    Set up the order that the results should be returned in.
    
    Parameters:
    
    sequencingOrder - enum for the sequencing order
  - toString
```
public String toString()
```
    JSON-style toString.
    
    Overrides:
    
    toString in class Object
    
    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 Object
    
    Parameters:
    
    objectToCompare - object to compare
    
    Returns:
    
    boolean result of comparison
  - hashCode
```
public int hashCode()
```
    Return hash code for this object
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    
    int hash code

Class FindRequestBody

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FindRequestBody

FindRequestBody

Method Detail

getMetadataElementTypeName

setMetadataElementTypeName

getMetadataElementSubtypeName

setMetadataElementSubtypeName

getSearchProperties

setSearchProperties

getLimitResultsByStatus

setLimitResultsByStatus

getMatchClassifications

setMatchClassifications

getSequencingProperty

setSequencingProperty

getSequencingOrder

setSequencingOrder

toString

equals

hashCode