/Users/rburkes/Projects/mobile/branches/release-1-2/devices/iphone/core/src/EMLib/EMSearchQuery.h

/*
Copyright 2001, 2012, Oracle and/or its affiliates. All rights reserved.
Oracle and Java are registered trademarks of Oracle and/or its 
affiliates. Other names may be trademarks of their respective owners.
UNIX is a registered trademark of The Open Group.

This software and related documentation are provided under a license 
agreement containing restrictions on use and disclosure and are 
protected by intellectual property laws. Except as expressly permitted 
in your license agreement or allowed by law, you may not use, copy, 
reproduce, translate, broadcast, modify, license, transmit, distribute, 
exhibit, perform, publish, or display any part, in any form, or by any 
means. Reverse engineering, disassembly, or decompilation of this 
software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice 
and is not warranted to be error-free. If you find any errors, please 
report them to us in writing.
U.S. GOVERNMENT END USERS: Oracle programs, including any operating 
system, integrated software, any programs installed on the hardware, 
and/or documentation, delivered to U.S. Government end users are 
"commercial computer software" pursuant to the applicable Federal 
Acquisition Regulation and agency-specific supplemental regulations. 
As such, use, duplication, disclosure, modification, and adaptation 
of the programs, including any operating system, integrated software, 
any programs installed on the hardware, and/or documentation, shall be 
subject to license terms and license restrictions applicable to the 
programs. No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety 
of information management applications. It is not developed or 
intended for use in any inherently dangerous applications, including 
applications that may create a risk of personal injury. If you use 
this software or hardware in dangerous applications, then you shall 
be responsible to take all appropriate fail-safe, backup, redundancy, 
and other measures to ensure its safe use. Oracle Corporation and its 
affiliates disclaim any liability for any damages caused by use of this 
software or hardware in dangerous applications.
This software or hardware and documentation may provide access to or 
information on content, products, and services from third parties. 
Oracle Corporation and its affiliates are not responsible for and 
expressly disclaim all warranties of any kind with respect to 
third-party content, products, and services. Oracle Corporation and 
its affiliates will not be responsible for any loss, costs, or damages 
incurred due to your access to or use of third-party content, products, 
or services.
*/


#import <Three20/Three20.h>
#import "EMPageableDataSource.h"

@interface EMSearch : NSObject<NSCopying, NSCoding> {
        NSString *_key, *_terms, *_opts;
}
@property (nonatomic, retain) NSString *key, *terms, *opts;

+ (EMSearch *) searchWithKey:(NSString *)key terms:(NSString *)terms;
+ (EMSearch *) searchWithKey:(NSString *)key terms:(NSString *)terms opts:(NSString *)opts;
- (id) initWithKey:(NSString *)key terms:(NSString *)terms;
- (id) initWithKey:(NSString *)key terms:(NSString *)terms opts:(NSString *)opts;

@end


#pragma mark -


static const NSUInteger SORT_ORDER_ASCENDING = 0;
static const NSUInteger SORT_ORDER_DESCENDING = 1;

@interface EMSort : NSObject<NSCopying, NSCoding> {
        NSString *_key, *_displayValue;
        NSUInteger _order;
        BOOL _momentary;
        
        NSString *_ascendingIndicator;
        NSString *_descendingIndicator;
}

@property (nonatomic, retain) NSString *key;

@property (nonatomic, retain) NSString *displayValue;

@property (nonatomic, assign) NSUInteger order;

@property (nonatomic, assign) BOOL momentary;

@property (nonatomic, retain) NSString *ascendingIndicator;

@property (nonatomic, retain) NSString *descendingIndicator;

+ (EMSort *) sortWithKey:(NSString *)key displayValue:(NSString *)displayValue;
- (id) initWithKey:(NSString *)key displayValue:(NSString *)displayValue;

+ (EMSort *) sortWithKey:(NSString *)key order:(NSUInteger)order displayValue:(NSString *)displayValue;
- (id) initWithKey:(NSString *)key order:(NSUInteger)order displayValue:(NSString *)displayValue;

+ (EMSort *) sortWithKey:(NSString *)key order:(NSUInteger)order displayValue:(NSString *)displayValue momentary:(BOOL)momentary;
- (id) initWithKey:(NSString *)key order:(NSUInteger)order displayValue:(NSString *)displayValue momentary:(BOOL)momentary;

- (BOOL) isEqual:(EMSort *)sort;

@end


#pragma mark -


@interface EMSearchQuery : NSObject<NSCopying, NSCoding> {
        NSMutableArray *_searches;
        
        NSMutableArray *_appliedFacets;
        NSMutableArray *_hiddenFacets;
        NSMutableArray *_searchFacets;
        
        NSMutableArray *_rangeFilters;
        NSString *_recordFilter;
        
        NSMutableArray *_exposedFacets;
        BOOL _returnFacets;
        BOOL _exposeAllFacets;
        BOOL _didYouMeanEnabled;
        
        NSMutableArray *_sorts;
        
        NSInteger _offset;
        NSInteger _recordsPerPage;

        BOOL _categoryQuery;
        
        Class _recordType;
        
        NSMutableArray *_recordSpecs;
        
        NSMutableDictionary *_requestParameters;
}

+ (id) queryWithRecordType:(Class)recordType;

@property (nonatomic, retain) NSMutableArray *searches;

@property (nonatomic, retain) NSMutableArray *appliedFacets;

@property (nonatomic, retain) NSMutableArray *hiddenFacets;

@property (nonatomic, retain) NSMutableArray *rangeFilters;

@property (nonatomic, retain) NSString *recordFilter;

@property (nonatomic, retain) NSMutableArray *exposedFacets;

@property (nonatomic, retain) NSMutableArray *sorts;

@property (nonatomic, assign) NSInteger offset;

@property (nonatomic, assign) NSInteger recordsPerPage;

@property (nonatomic, assign) Class recordType;

@property (nonatomic, assign) BOOL returnFacets;

@property (nonatomic, assign) BOOL exposeAllFacets;

@property (nonatomic, retain) NSMutableArray *recordSpecs;

- (BOOL) isEmpty;

@property (nonatomic, assign) BOOL categoryQuery;

@property (nonatomic, assign) BOOL didYouMeanEnabled;

@property (nonatomic, retain) NSMutableDictionary *requestParameters;

- (void) augmentQuery:(EMSearchQuery *)query;

- (void) clearAllFilters:(BOOL)clearHidden;

@end


#pragma mark -


@class EMContentItem;

@interface EMSearchResult : NSObject {
        NSInteger _offset;
        NSMutableArray *_records;
        NSMutableArray *_facets;
        NSMutableArray *_searchFacets;
        NSInteger _totalRecords;
        
        NSString *_title;
        
        BOOL _categoryResult;
        
        Class _recordType;
        
        NSString *_didYouMean, *_autocorrect;
        
        EMContentItem *_contentItem;
}

- (id) initWithRecordType:(Class)recordType;

@property (nonatomic, assign) NSInteger offset;

@property (nonatomic, retain) NSMutableArray *records;

@property (nonatomic, retain) NSMutableArray *facets;

@property (nonatomic, retain) NSMutableArray *searchFacets;

@property (nonatomic, assign) NSInteger totalRecords;

@property (nonatomic, readonly) Class recordType;

@property (nonatomic, retain) NSString *title;

@property (nonatomic, assign) BOOL categoryResult;

@property (nonatomic, retain) NSString *didYouMean;

@property (nonatomic, retain) NSString *autocorrect;

@property (nonatomic, retain) EMContentItem *contentItem;

@end


#pragma mark -


@protocol EMURLSearchResponse <TTURLResponse> 

- (id) initWithRecordType:(Class)recordType;

@property (nonatomic, readonly) EMSearchResult *result;

@property (nonatomic, readonly) Class recordType;

@end


#pragma mark -


@protocol EMSearchQueryDataSource <EMPageableDataSource>

@property(nonatomic, retain) EMSearchQuery *query;

@property(nonatomic, readonly) EMSearchResult *result;

- (void) submitQuery;


@end

/* 
 *   @} 
 * @} 
 */