NSFNanoSearch.h in nano-store-0.6.1

- old
+ new

@@ -178,10 +178,12 @@
 @property (nonatomic, copy, readwrite) NSString *filterClass;
 /** * If an expression has an offset clause, then the first M rows are omitted from the result set returned by the search operation and the next N rows are returned, where M and N are the values that the offset and limit clauses evaluate to, respectively. Or, if the search would return less than M+N rows if it did not have a limit clause, then the first M rows are skipped and the remaining rows (if any) are returned. */
 @property (nonatomic, assign, readwrite) NSUInteger offset;
 /** * The limit clause is used to place an upper bound on the number of rows returned by a Search operation. */
 @property (nonatomic, assign, readwrite) NSUInteger limit;
+/** * limit a Search to a particular bag. */
+@property (nonatomic, assign, readwrite) NSFNanoBag *bag;
 
 /** @name Creating and Initializing a Search
  */
 
 //@{
@@ -211,11 +213,11 @@
 
 /** * Performs a search using the values of the properties.
  * @param theReturnType the type of object to be returned. Can be \link Globals::NSFReturnObjects NSFReturnObjects \endlink or \link Globals::NSFReturnKeys NSFReturnKeys \endlink.
  * @param outError is used if an error occurs. May be NULL.
  * @return An array is returned if: 1) the sort has been specified or 2) the return type is \link Globals::NSFReturnKeys NSFReturnKeys \endlink. Otherwise, a dictionary is returned.
- * @note The sort descriptor will be ignored when returning requesting NSFReturnKeys.
+ * @note The sort descriptor will be ignored when the return type is NSFReturnKeys.
  * @see \link searchObjectsAdded:date:returnType:error: - (id)searchObjectsAdded:(NSFDateMatchType)theDateMatch date:(NSDate *)theDate returnType:(NSFReturnType)theReturnType error:(out NSError **)outError \endlink
  */
 
 - (id)searchObjectsWithReturnType:(NSFReturnType)theReturnType error:(out NSError **)outError;
 
@@ -223,10 +225,10 @@
  * @param theDateMatch the type of date comparison. Can be \link Globals::NSFBeforeDate NSFBeforeDate \endlink, \link Globals::NSFOnDate NSFOnDate \endlink or \link Globals::NSFAfterDate NSFAfterDate \endlink.
  * @param theDate the date to use as a pivot during the search.
  * @param theReturnType the type of object to be returned. Can be \link Globals::NSFReturnObjects NSFReturnObjects \endlink or \link Globals::NSFReturnKeys NSFReturnKeys \endlink.
  * @param outError is used if an error occurs. May be NULL.
  * @return If theReturnType is \link Globals::NSFReturnObjects NSFReturnObjects \endlink, a dictionary is returned. Otherwise, an array is returned.
- * @note The sort descriptor will be ignored when returning requesting NSFReturnKeys.
+ * @note The sort descriptor will be ignored when the return type is NSFReturnKeys.
  * @see \link searchObjectsWithReturnType:error: - (id)searchObjectsWithReturnType:(NSFReturnType)theReturnType error:(out NSError **)outError \endlink
  */
 
 - (id)searchObjectsAdded:(NSFDateMatchType)theDateMatch date:(NSDate *)theDate returnType:(NSFReturnType)theReturnType error:(out NSError **)outError;
 
\ No newline at end of file