Files
RestKit/Code/Three20/RKRequestFilterableTTModel.h

60 lines
1.4 KiB
Objective-C

//
// RKRequestFilterableTTModel.h
// RestKit
//
// Created by Blake Watters on 2/12/10.
// Copyright 2010 Two Toasters. All rights reserved.
//
#import "RKRequestTTModel.h"
#import <RestKit/RKSearchEngine.h>
/**
* Provides an interface for searching and filtering a collection
* of objects loaded from a remote source
*/
@interface RKRequestFilterableTTModel : RKRequestTTModel {
RKSearchEngine* _searchEngine;
NSPredicate* _predicate;
NSSortDescriptor* _sortDescriptor;
NSString* _searchText;
}
/**
* A predicate to filter the model objects by
*/
@property (nonatomic, retain) NSPredicate* predicate;
/**
* A sort descriptor to sort the objects by
*/
@property (nonatomic, retain) NSSortDescriptor* sortDescriptor;
/**
* A search engine instance for searching the data. If none is assigned,
* a default search engine will be created for you
*/
@property (nonatomic, retain) RKSearchEngine* searchEngine;
/**
* Creates an RKSearchEngine instance for searching the collection.
*/
- (RKSearchEngine*)createSearchEngine;
/**
* Resets the model by clearing the filter, sort descriptor, and search text
*/
- (void)reset;
/**
* Triggered when the model was search with empty text. Default implementation preserves filtered collection.
*/
- (NSArray*)didSearchCollectionWithEmptyText:(NSArray*)collection;
/**
* Search the model for matching text
*/
- (void)search:(NSString *)text;
@end