org.odpi.openmetadata.repositoryservices.rest.properties

Class OMRSAPIPagedFindRequest

java.lang.Object

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIRequest

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedFindRequest

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

RelatedEntitiesFindRequest, TypeLimitedFindRequest

public class OMRSAPIPagedFindRequest
extends OMRSAPIFindRequest

OMRSAPIPagedFindRequest provides support for the paging parameters of a find request.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OMRSAPIPagedFindRequest() Default constructor
OMRSAPIPagedFindRequest(OMRSAPIPagedFindRequest 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.
int	getOffset() Return the starting element number for this set of results.
int	getPageSize() Return the maximum number of elements that can be returned on this request.
SequencingOrder	getSequencingOrder() Return the sequencing order for the results.
String	getSequencingProperty() Return the name of the property that should be used to sequence the results.
int	hashCode() Create a hash code for this element type.
void	setOffset(int offset) Set up the starting element number for this set of results.
void	setPageSize(int pageSize) Set up the maximum number of elements that can be returned on this request.
void	setSequencingOrder(SequencingOrder sequencingOrder) Set up the sequencing order for the results.
void	setSequencingProperty(String sequencingProperty) Set up the name of the property that should be used to sequence the results.
String	toString() Standard toString method.

Methods inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIFindRequest

getLimitResultsByStatus, setLimitResultsByStatus

Methods inherited from class java.lang.Object

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

Constructor Detail

OMRSAPIPagedFindRequest

public OMRSAPIPagedFindRequest()

Default constructor

OMRSAPIPagedFindRequest

public OMRSAPIPagedFindRequest(OMRSAPIPagedFindRequest template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getSequencingProperty

public String getSequencingProperty()

Return the name of the property that should be used to sequence the results.

Returns:

property name

setSequencingProperty

public void setSequencingProperty(String sequencingProperty)

Set up the name of the property that should be used to sequence the results.

Parameters:

sequencingProperty - property name

getSequencingOrder

public SequencingOrder getSequencingOrder()

Return the sequencing order for the results.

Returns:

sequencing order enum

setSequencingOrder

public void setSequencingOrder(SequencingOrder sequencingOrder)

Set up the sequencing order for the results.

Parameters:

sequencingOrder - sequencing order enum

getOffset

public int getOffset()

Return the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

Returns:

offset number

setOffset

public void setOffset(int offset)

Set up the starting element number for this set of results. This is used when retrieving elements beyond the first page of results. Zero means the results start from the first element.

Parameters:

offset - offset number

getPageSize

public int getPageSize()

Return the maximum number of elements that can be returned on this request.

Returns:

page size

setPageSize

public void setPageSize(int pageSize)

Set up the maximum number of elements that can be returned on this request.

Parameters:

pageSize - integer number

toString

public String toString()

Standard toString method.

Overrides:

toString in class OMRSAPIFindRequest

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 OMRSAPIFindRequest

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 OMRSAPIFindRequest

Returns:

int hash code