org.odpi.openmetadata.repositoryservices.rest.properties

Class OMRSAPIPagedResponse

java.lang.Object

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse

org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIPagedResponse

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CohortListResponse, CohortMembershipListResponse, EntityListResponse, RelationshipListResponse

public abstract class OMRSAPIPagedResponse
extends OMRSAPIResponse

OMRSRESTAPIPagedResponse provides the base definition for a paged response.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected String	nextPageURL
protected int	offset
protected int	pageSize

Fields inherited from class org.odpi.openmetadata.repositoryservices.rest.properties.OMRSAPIResponse

actionDescription, exceptionCausedBy, exceptionClassName, exceptionErrorMessage, exceptionErrorMessageId, exceptionErrorMessageParameters, exceptionProperties, exceptionSystemAction, exceptionUserAction, relatedHTTPCode

Constructor Summary

Constructors

Constructor and Description
OMRSAPIPagedResponse() Default constructor
OMRSAPIPagedResponse(OMRSAPIPagedResponse 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	getNextPageURL() Return the url that can be used to retrieve the next page.
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.
int	hashCode() Create a hash code for this element type.
void	setNextPageURL(String nextPageURL) Set up the url that can be used to retrieve the next page.
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.
String	toString() Standard toString method.

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

getActionDescription, getExceptionCausedBy, getExceptionClassName, getExceptionErrorMessage, getExceptionErrorMessageId, getExceptionErrorMessageParameters, getExceptionProperties, getExceptionSystemAction, getExceptionUserAction, getRelatedHTTPCode, setActionDescription, setExceptionCausedBy, setExceptionClassName, setExceptionErrorMessage, setExceptionErrorMessageId, setExceptionErrorMessageParameters, setExceptionProperties, setExceptionSystemAction, setExceptionUserAction, setRelatedHTTPCode

Methods inherited from class java.lang.Object

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

Field Detail

nextPageURL

protected String nextPageURL

offset

protected int offset

pageSize

protected int pageSize

Constructor Detail

OMRSAPIPagedResponse

public OMRSAPIPagedResponse()

Default constructor

OMRSAPIPagedResponse

public OMRSAPIPagedResponse(OMRSAPIPagedResponse template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getNextPageURL

public String getNextPageURL()

Return the url that can be used to retrieve the next page.

Returns:

url string

setNextPageURL

public void setNextPageURL(String nextPageURL)

Set up the url that can be used to retrieve the next page.

Parameters:

nextPageURL - url string

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 OMRSAPIResponse

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 OMRSAPIResponse

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 OMRSAPIResponse

Returns:

int hash code