Inherits from NSObject
Conforms to NSCoding
Declared in AlfrescoListingContext.h

Overview

The AlfrescoListingContext can be used to specify paging and filter values. If not provided maximum items will default to 50 and skip count will default to 0.

Author: Gavin Cornwell (Alfresco), Tijs Rademakers (Alfresco), Peter Schmidt (Alfresco)

Tasks

Properties

listingFilter

Returns the listing filter.

@property (nonatomic, strong) AlfrescoListingFilter *listingFilter

Discussion

Returns the listing filter.

Declared In

AlfrescoListingContext.h

maxItems

Returns the maximum items within the list.

@property (nonatomic, assign) int maxItems

Discussion

Returns the maximum items within the list.

Declared In

AlfrescoListingContext.h

skipCount

Returns current skip count.

@property (nonatomic, assign) int skipCount

Discussion

Returns current skip count.

Declared In

AlfrescoListingContext.h

sortAscending

Returns the sorting direction.

@property (nonatomic, assign) BOOL sortAscending

Discussion

Returns the sorting direction.

Declared In

AlfrescoListingContext.h

sortProperty

Returns the sorting field for the list.

@property (nonatomic, strong) NSString *sortProperty

Discussion

Returns the sorting field for the list.

Declared In

AlfrescoListingContext.h

Instance Methods

initWithListingFilter:

Creates and returns a listing context with filtered items.

- (id)initWithListingFilter:(AlfrescoListingFilter *)listingFilter

Parameters

listingFilter

The filtering that must be applied to the returned items.

Discussion

Creates and returns a listing context with filtered items.

Declared In

AlfrescoListingContext.h

initWithMaxItems:

Creates and returns a listing context with a maximum number of items.

- (id)initWithMaxItems:(int)maxItems

Parameters

maxItems

The maximum number of items to be returned, 0 or -1 will be interpreted as all items.

Discussion

Creates and returns a listing context with a maximum number of items.

Declared In

AlfrescoListingContext.h

initWithMaxItems:skipCount:

Creates and returns a listing context with a maximum number of items after skipping the given number of items.

- (id)initWithMaxItems:(int)maxItems skipCount:(int)skipCount

Parameters

maxItems

The maximum number of items to be returned, 0 or -1 will be interpreted as all items.

skipCount

The number of items to skip before results are returned.

Discussion

Creates and returns a listing context with a maximum number of items after skipping the given number of items.

Declared In

AlfrescoListingContext.h

initWithMaxItems:skipCount:sortProperty:sortAscending:

Creates and returns a listing context with a maximum number of sorted items after skipping the given number of items.

- (id)initWithMaxItems:(int)maxItems skipCount:(int)skipCount sortProperty:(NSString *)sortProperty sortAscending:(BOOL)sortAscending

Parameters

maxItems

The maximum number of items to be returned, 0 or -1 will be interpreted as all items.

skipCount

The number of items to skip before results are returned.

sortProperty

A string indicating which value should be used for sorting. A nil string (or invalid string) will result in default sorting.

sortAscending

Determines whether the sorting should be ascending.

Discussion

Creates and returns a listing context with a maximum number of sorted items after skipping the given number of items.

Declared In

AlfrescoListingContext.h

initWithMaxItems:skipCount:sortProperty:sortAscending:listingFilter:

Creates and returns a listing context with a maximum number of sorted and filtered items after skipping the given number of items.

- (id)initWithMaxItems:(int)maxItems skipCount:(int)skipCount sortProperty:(NSString *)sortProperty sortAscending:(BOOL)sortAscending listingFilter:(AlfrescoListingFilter *)listingFilter

Parameters

maxItems

The maximum number of items to be returned, 0 or -1 will be interpreted as all items.

skipCount

The number of items to skip before results are returned.

sortProperty

A string indicating which value should be used for sorting. A nil string (or invalid string) will result in default sorting.

sortAscending

Determines whether the sorting should be ascending.

listingFilter

The filtering that must be applied to the returned items.

Discussion

Creates and returns a listing context with a maximum number of sorted and filtered items after skipping the given number of items.

Declared In

AlfrescoListingContext.h

initWithSortProperty:sortAscending:

Creates and returns a listing context with sorted items.

- (id)initWithSortProperty:(NSString *)sortProperty sortAscending:(BOOL)sortAscending

Parameters

sortProperty

A string indicating which value should be used for sorting. A nil string (or invalid string) will result in default sorting.

sortAscending

Determines whether the sorting should be ascending.

Discussion

Creates and returns a listing context with sorted items.

Declared In

AlfrescoListingContext.h