org.alfresco.mobile.android.api.model

Class ListingContext

java.lang.Object

org.alfresco.mobile.android.api.model.ListingContext

All Implemented Interfaces:

Serializable

public class ListingContext
extends Object
implements Serializable

Provides informations to manage behaviour of an Mobile SDK object list and/or pagingResult
Generally used in combination with List

Author:

Jean Marie Pascal

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_ITEMS The Constant DEFAULT_MAX_ITEMS.

Constructor Summary

Constructors

Constructor and Description
ListingContext() Instantiates a new listing context.
ListingContext(String sorting, int maxItems, int skipCount, boolean sortingModifier) Instantiates a new listing context.

Method Summary

Methods

Modifier and Type	Method and Description
ListingFilter	getFilter() Returns the ListingFilter associated to the current ListingContext.
int	getMaxItems() Returns the maximum items within the list.
int	getSkipCount() Returns current skip count
String	getSortProperty() Returns the sorting field for the list.
boolean	isSortAscending() Define the sorting direction.
void	setFilter(ListingFilter filter) Sets the ListingFilter.
void	setIsSortAscending(Boolean sortAscending) Returns the sorting direction.
void	setMaxItems(int maxItems) Sets the max items.
void	setSkipCount(int skipCount) Sets the skip count.
void	setSortProperty(String sortProperty) Define the sorting field for the list.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAX_ITEMS

public static final int DEFAULT_MAX_ITEMS

The Constant DEFAULT_MAX_ITEMS.

See Also:

Constant Field Values

Constructor Detail

ListingContext

public ListingContext()

Instantiates a new listing context.

ListingContext

public ListingContext(String sorting,
              int maxItems,
              int skipCount,
              boolean sortingModifier)

Instantiates a new listing context.

Parameters:

sorting - the sorting

maxItems - the max items

skipCount - the skip count

sortingModifier - the sorting modifier

Method Detail

getSortProperty

public String getSortProperty()

Returns the sorting field for the list.

Returns:

the sort property

setSortProperty

public void setSortProperty(String sortProperty)

Define the sorting field for the list.

Parameters:

sortProperty - the new sort property

isSortAscending

public boolean isSortAscending()

Define the sorting direction.

Returns:

the sorting direction.

setIsSortAscending

public void setIsSortAscending(Boolean sortAscending)

Returns the sorting direction.

Parameters:

sortAscending - the new checks if is sort ascending

getMaxItems

public int getMaxItems()

Returns the maximum items within the list.

Returns:

the max items. If maxItems <= 0 replace by default Max Items

setMaxItems

public void setMaxItems(int maxItems)

Sets the max items.

Parameters:

maxItems - : maximum items Sets the maximum items inside the list.

getSkipCount

public int getSkipCount()

Returns current skip count

Returns:

the skip count. If skipCount < 0, returns 0.

setSkipCount

public void setSkipCount(int skipCount)

Sets the skip count.

Parameters:

skipCount - : current skip count Sets the current skip count.

getFilter

public ListingFilter getFilter()

Returns the ListingFilter associated to the current ListingContext.

Since:

1.3

setFilter

public void setFilter(ListingFilter filter)

Sets the ListingFilter.

Parameters:

filter - :

Since:

1.3