org.jboss.aerogear.android.pipeline.paging
Class PageConfig

java.lang.Object
  org.jboss.aerogear.android.pipeline.paging.PageConfig

public class PageConfig
extends Object

Nested Class Summary

static class

PageConfig.MetadataLocations

Constructor Summary

PageConfig()

Method Summary

Integer	getLimitValue() LimitValue is the maximum number of results the server should return (default: 10)
MetadataLocation	getMetadataLocation() MetadataLocation indicates whether paging information is received from the response header, the response body (body) or via RFC 5988 (webLinking), which is the default
String	getNextIdentifier() NextIdentifier names the element containing data for the next page (default: next)
String	getOffsetValue() OffsetValue is the offset of the first element that should be included in the returned collection (default: 0)
PageParameterExtractor	getPageParameterExtractor() PageParameterExtractor is the a PageParameterExtractor which parses the response and provides data to a Pipe for the "next" and "previous" pages.
ParameterProvider	getParameterProvider() The ParameterProvider for paging.
String	getPreviousIdentifier() PreviousIdentifier names the element containing data for the previous page (default: previous)
void	setLimitValue(Integer limitValue) LimitValue is the maximum number of results the server should return (default: 10)
void	setMetadataLocation(MetadataLocation metadataLocation) MetadataLocation indicates whether paging information is received from the response header, the response body (body) or via RFC 5988 (webLinking), which is the default
void	setNextIdentifier(String nextIdentifier) NextIdentifier names the element containing data for the next page (default: next)
void	setOffsetValue(String offsetValue) OffsetValue is the offset of the first element that should be included in the returned collection (default: 0)
void	setPageParameterExtractor(PageParameterExtractor pageParameterExtractor) PageParameterExtractor is the a PageParameterExtractor which parses the response and provides data to a Pipe for the "next" and "previous" pages.
void	setParameterProvider(ParameterProvider parameterProvider) The ParameterProvider for paging.
void	setPreviousIdentifier(String previousIdentifier) PreviousIdentifier names the element containing data for the previous page (default: previous)

Methods inherited from class java.lang.Object

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

Constructor Detail

PageConfig

public PageConfig()

Method Detail

getMetadataLocation

public MetadataLocation getMetadataLocation()

MetadataLocation indicates whether paging information is received from the response header, the response body (body) or via RFC 5988 (webLinking), which is the default

Returns:

the current location

setMetadataLocation

public void setMetadataLocation(MetadataLocation metadataLocation)

MetadataLocation indicates whether paging information is received from the response header, the response body (body) or via RFC 5988 (webLinking), which is the default

Parameters:

metadataLocation - a different metaDataLocation

getNextIdentifier

public String getNextIdentifier()

NextIdentifier names the element containing data for the next page (default: next)

Returns:

the current identifier

setNextIdentifier

public void setNextIdentifier(String nextIdentifier)

NextIdentifier names the element containing data for the next page (default: next)

getPreviousIdentifier

public String getPreviousIdentifier()

PreviousIdentifier names the element containing data for the previous page (default: previous)

Returns:

the current identifier

setPreviousIdentifier

public void setPreviousIdentifier(String previousIdentifier)

PreviousIdentifier names the element containing data for the previous page (default: previous)

Parameters:

previousIdentifier -

getOffsetValue

public String getOffsetValue()

OffsetValue is the offset of the first element that should be included in the returned collection (default: 0)

Returns:

the current offset

setOffsetValue

public void setOffsetValue(String offsetValue)

OffsetValue is the offset of the first element that should be included in the returned collection (default: 0)

Parameters:

offsetValue -

getLimitValue

public Integer getLimitValue()

LimitValue is the maximum number of results the server should return (default: 10)

Returns:

the current limit

setLimitValue

public void setLimitValue(Integer limitValue)

LimitValue is the maximum number of results the server should return (default: 10)

Parameters:

limitValue - a new Limit value

getParameterProvider

public ParameterProvider getParameterProvider()

The ParameterProvider for paging. Defaults to DefaultParameterProvider

Returns:

the current provider

setParameterProvider

public void setParameterProvider(ParameterProvider parameterProvider)

The ParameterProvider for paging. Defaults to DefaultParameterProvider

Parameters:

parameterProvider - a new provider

getPageParameterExtractor

public PageParameterExtractor getPageParameterExtractor()

PageParameterExtractor is the a PageParameterExtractor which parses the response and provides data to a Pipe for the "next" and "previous" pages. The default value depends on the current setting of MetadataLocation.

Returns:

the current PageParameterExtractor

setPageParameterExtractor

public void setPageParameterExtractor(PageParameterExtractor pageParameterExtractor)

PageParameterExtractor is the a PageParameterExtractor which parses the response and provides data to a Pipe for the "next" and "previous" pages. The default value depends on the current setting of MetadataLocation.

Parameters:

pageParameterExtractor - an new Extractor