org.odpi.openmetadata.commonservices.ffdc.rest

Class SearchStringRequestBody

java.lang.Object

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

All Implemented Interfaces:

Serializable

public class SearchStringRequestBody
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
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.
String	toString() Standard toString method.

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchStringRequestBody

public SearchStringRequestBody()

Default constructor

SearchStringRequestBody

public SearchStringRequestBody(SearchStringRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

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

toString

public String toString()

Standard toString method.

Overrides:

toString in class Object

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 Object

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 Object

Returns:

int hash code