Package org.odpi.openmetadata.commonservices.ffdc.rest

Class SearchStringRequestBody

java.lang.Object

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

org.odpi.openmetadata.commonservices.ffdc.rest.SearchStringRequestBody

public class SearchStringRequestBody
extends ResultsRequestBody

SearchStringRequestBody is the request body structure used on OMAG REST API calls that passes a regular expression to use as a search string.

Constructor Summary

Constructors

Constructor	Description
SearchStringRequestBody()	Default constructor
SearchStringRequestBody(SearchStringRequestBody template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Compare the values of the supplied object with those stored in the current object.
String	getSearchString()	Return the search request.
String	getSearchStringParameterName()	Return the search string parameter name.
String	getTypeName()	Return the optional type name for the search results (null means any type).
int	hashCode()	Create a hash code for this element type.
void	setSearchString(String searchString)	Set up the search.
void	setSearchStringParameterName(String searchStringParameterName)	Set up the search string parameter name.
void	setTypeName(String typeName)	Set up the optional type name for the search results (null means any type).
String	toString()	Standard toString method.

Methods inherited from class org.odpi.openmetadata.commonservices.ffdc.rest.ResultsRequestBody

getAsOfTime, getEffectiveTime, getForDuplicateProcessing, getForLineage, getLimitResultsByStatus, getSequencingOrder, getSequencingProperty, getTemplateFilter, setAsOfTime, setEffectiveTime, setForDuplicateProcessing, setForLineage, setLimitResultsByStatus, setSequencingOrder, setSequencingProperty, setTemplateFilter

Methods inherited from class java.lang.Object

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

Constructor Details

SearchStringRequestBody

public SearchStringRequestBody()

Default constructor

SearchStringRequestBody

public SearchStringRequestBody(SearchStringRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getSearchString

public String getSearchString()

Return the search request.

Returns:

regEx expression

setSearchString

public void setSearchString(String searchString)

Set up the search.

Parameters:

searchString - regEx expression

getSearchStringParameterName

public String getSearchStringParameterName()

Return the search string parameter name.

Returns:

string name

setSearchStringParameterName

public void setSearchStringParameterName(String searchStringParameterName)

Set up the search string parameter name.

Parameters:

searchStringParameterName - string name

getTypeName

public String getTypeName()

Return the optional type name for the search results (null means any type).

Returns:

unique name of type

setTypeName

public void setTypeName(String typeName)

Set up the optional type name for the search results (null means any type).

Parameters:

typeName - unique name of type

toString

public String toString()

Standard toString method.

Overrides:

toString in class ResultsRequestBody

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 ResultsRequestBody

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 ResultsRequestBody

Returns:

int hash code