org.mule.modules.box

Class BasicPagingDelegate<T>

java.lang.Object

org.mule.streaming.ProviderAwarePagingDelegate<T,BoxConnector>

org.mule.modules.box.BasicPagingDelegate<T>

Type Parameters:

T - The type returned by the client call that returns the pages.

All Implemented Interfaces:

org.mule.api.Closeable

public abstract class BasicPagingDelegate<T>
extends org.mule.streaming.ProviderAwarePagingDelegate<T,BoxConnector>

Abstract paging delegate used for paginated endpoints that provide offset and maxReturn parameters.

Field Summary

Fields

Modifier and Type	Field and Description
protected Integer	offset The offset required in paginated calls.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicPagingDelegate(org.mule.streaming.PagingConfiguration pagingConfiguration)

Method Summary

Modifier and Type	Method and Description
void	close()
protected abstract List<T>	doCall(BoxConnector provider) Returns a list of elements corresponding to a page.
List<T>	getPage(BoxConnector provider)
protected Integer	getPageSize()
int	getTotalResults(BoxConnector provider)
protected void	setTotalResults(Integer totalResults)

Methods inherited from class java.lang.Object

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

Field Detail

offset

protected Integer offset

The offset required in paginated calls. Initial value is 0, meaning that the first call will fetch the first N records of the folder listing. Note: Since the result pages can have fewer records than the limit/pageSize specified, the next offset should be = offset + pageSize, not the # of records received.

Constructor Detail

BasicPagingDelegate

protected BasicPagingDelegate(org.mule.streaming.PagingConfiguration pagingConfiguration)

Method Detail

getPage

public List<T> getPage(BoxConnector provider)
                throws Exception

Specified by:

getPage in class org.mule.streaming.ProviderAwarePagingDelegate<T,BoxConnector>

Throws:

Exception

doCall

protected abstract List<T> doCall(BoxConnector provider)

Returns a list of elements corresponding to a page.

Parameters:

provider - The connector.

Returns:

The list of elements. If the call was not successful. (?)

close

public void close()
           throws org.mule.api.MuleException

Throws:

org.mule.api.MuleException

getTotalResults

public int getTotalResults(BoxConnector provider)
                    throws Exception

Specified by:

getTotalResults in class org.mule.streaming.ProviderAwarePagingDelegate<T,BoxConnector>

Throws:

Exception

setTotalResults

protected void setTotalResults(Integer totalResults)

getPageSize

protected Integer getPageSize()