Provides the ability to create complex search queries.
Type Template
<...>
<afterDate>xs:dateTime</afterDate>
<beforeDate>xs:dateTime</beforeDate>
<queryString>xs:string</queryString>
<sortField>xs:int</sortField>
<sortOrder>xs:int</sortOrder>
<...>Note: Element descriptions are split into information that's
relevant when you're creating an instance of this type and information
relevant when you're receiving an instance of it. Occasionally these
will differ.
Elements
| Element |
Description |
| afterDate
|
- Setting
- Sets the earliest date for search results. For example, the "after date"
can be used to search for messages modified within the last week.
- Getting
- Returns the earliest date for search results. For example, the "after date"
can be used to search for messages modified within the last week.
If the "after date" has not been set, this method will return null.
|
| beforeDate
|
- Setting
- Sets the latest date for search results. For example, the "before date"
can be used to search for messages modified more than 1 month ago.
- Getting
- Returns the latest date for search results. For example, the "before date"
can be used to search for messages modified more than 1 month ago.
If the "before date" has not been set, this method will return null.
|
| queryString
|
- Setting
- Sets the query string for the Query object.
- Getting
- Returns the query string for the Query object. If the query string has
not been set, this method will return null.
|
| sortField
|
- Setting
- Sets the sort field to use. Default is Query.RELEVANCE.
- Getting
- Returns the currently selected sort field. Default is Query.RELEVANCE.
|
| sortOrder
|
- Setting
- Sets the sort type. Valid arguments are Query.ASCENDING for ascending sorting or
Query.DESCENDING for descending sorting. Descending sorting is: 3, 2, 1, etc.
Ascending sorting is 1, 2, 3, etc.
- Getting
- Returns the sort order, which will be Query.ASCENDING for ascending sorting, or
Query.DESCENDING for descending sorting. Descending sorting is: 3, 2, 1, etc.
Ascending sorting is 1, 2, 3, etc.
|