uk.co.visalia.brightpearl.apiclient.search

Class SearchResultsMetaData

java.lang.Object

uk.co.visalia.brightpearl.apiclient.search.SearchResultsMetaData

All Implemented Interfaces:

Serializable

public class SearchResultsMetaData
extends Object
implements Serializable

Contains the metadata of a response from a search resource, describing which search columns were returned, the sort order applied, and the number of available results. http://brightpearl.com/developer/latest/tutorial/working-with-resource-search.html

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SearchResultsMetaData()

Method Summary

Methods

Modifier and Type	Method and Description
List<SearchColumn>	getColumns() The columns included in the response.
Integer	getFirstResult() Returns the position of the first result on the current page.
Integer	getLastResult() Returns the position of the last result on the current page.
Integer	getResultsAvailable() Returns the total number of results that matched the filters supplied.
Integer	getResultsReturned() Returns the number of results included on the current page.
List<SearchSort>	getSorting() The sorting applied to the results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SearchResultsMetaData

public SearchResultsMetaData()

Method Detail

getColumns

public List<SearchColumn> getColumns()

The columns included in the response.

getSorting

public List<SearchSort> getSorting()

The sorting applied to the results.

getResultsAvailable

public Integer getResultsAvailable()

Returns the total number of results that matched the filters supplied.

getResultsReturned

public Integer getResultsReturned()

Returns the number of results included on the current page.

getFirstResult

public Integer getFirstResult()

Returns the position of the first result on the current page.

getLastResult

public Integer getLastResult()

Returns the position of the last result on the current page.