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

Class NameRequestBody

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.commonservices.ffdc.rest.NameRequestBody

public class NameRequestBody
extends ResultsRequestBody

NameRequestBody is the request body structure used on OMAG REST API calls that passes a name that is used to retrieve an element by name.

Constructor Summary

Constructors

Constructor	Description
NameRequestBody()	Default constructor
NameRequestBody(NameRequestBody template)	Copy/clone constructor
NameRequestBody(QueryOptions 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	getName()	Return the name for the query request.
String	getNameParameterName()	Return the parameter name.
String	getNamePropertyName()	Return the property name from the open metadata types.
int	hashCode()	Create a hash code for this element type.
void	setName(String name)	Set up the name for the query request.
void	setNameParameterName(String nameParameterName)	Set up the parameter name.
void	setNamePropertyName(String namePropertyName)	Set up the property name from the open metadata types.
String	toString()	Standard toString method.

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

NameRequestBody

public NameRequestBody()

Default constructor

NameRequestBody

public NameRequestBody(NameRequestBody template)

Copy/clone constructor

Parameters:

template - object to copy

NameRequestBody

public NameRequestBody(QueryOptions template)

Copy/clone constructor

Parameters:

template - object to copy

Method Details

getName

public String getName()

Return the name for the query request.

Returns:

string name

setName

public void setName(String name)

Set up the name for the query request.

Parameters:

name - string

getNameParameterName

public String getNameParameterName()

Return the parameter name.

Returns:

string name

setNameParameterName

public void setNameParameterName(String nameParameterName)

Set up the parameter name.

Parameters:

nameParameterName - string

getNamePropertyName

public String getNamePropertyName()

Return the property name from the open metadata types.

Returns:

string name

setNamePropertyName

public void setNamePropertyName(String namePropertyName)

Set up the property name from the open metadata types.

Parameters:

namePropertyName - string

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 QueryOptions

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 QueryOptions

Returns:

int hash code