class: SearchQuery

public abstract class: SearchQuery
Author: endres
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 16.07.2009 15:19:49; Modified: 16.07.2009 15:19:49;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {A38BD5D8-5793-4915-BB02-48B50E70EB48}
This interface provides a ADT for standard search queries.
 

Goto: Custom Properties, Fields, Methods

See also: ExportSearchQuery, MetadataSearchQuery, PlainCqlQuery, SortingOrder

Appears in: query

Connections
 
Custom Properties
 
SearchQuery Attributes
Attribute Details
private static const String
  CQL_DESCENDING_DEFINITION
Initial: ",,0"
Notes: Cql definition for a descending order of the search result
private static const String
  DEFAULT_MAXIMUM_RECORDS
Initial: "10000"
Notes: Maximum number of results.
private NonNegativeInteger
  maximumRecords
Initial: null
Notes: Defines how many results shall be retrieved.
private static const long
  serialVersionUID
Initial: 1L
Notes: Serial version identifier.
private SortingOrder
  sortingOrder
Initial: null
Notes: Sorting order
private String
  sortKeys
Initial: null
Notes: Sorting keys.
private PositiveInteger
  startRecord
Initial: null
Notes: Defines where the offset for the search result will be.
 
SearchQuery Methods
Operation Details
public abstract
getCqlQuery():String
Sequential
Tags: throws=CQLParseException,IOException,TechnicalException,ParseException
Notes: Get the Cql query of a standard search query.
@return cql query
public
getCqlSortingQuery():String
Sequential
Notes: Returns the Cql query for the sorting of the search result.
@return cql query defintion
public
getMaximumRecords():NonNegativeInteger
Sequential
public
getStartRecord():PositiveInteger
Sequential
public
SearchQuery():
Sequential
Notes: Default constructor.
public
setMaximumRecords(
   NonNegativeInteger maximumRecords):void
Sequential
public
setMaximumRecords(
   String maximumRecords):void
Sequential
public
setSortKeys(
   String keys):void
Sequential
Notes: Setter for the sort keys.
public
setSortKeysAndOrder(
   String keys,
   SortingOrder order):void
Sequential
Notes: Set the sortKeys and the order.
public
setSortOrder(
   SortingOrder order):void
Sequential
Notes: Set the sort order.
public
setStartRecord(
   PositiveInteger startRecord):void
Sequential
public
setStartRecord(
   String startRecord):void
Sequential