new module:models/OrderSearchRequest(query)
Constructs a new OrderSearchRequest.
Document representing an order search request.
Parameters:
| Name | Type | Description |
|---|---|---|
query |
module:models/Query | The query to apply |
- Source:
Members
(inner) count :Number
The number of returned documents
Type:
- Number
- Source:
(inner) db_start_record_ :Number
The zero-based index of the record that we want to start with, used to optimize special handling
Type:
- Number
- Source:
(inner) expand :Array.<String>
List of expansions to be applied to each search results. Expands are optional
Type:
- Array.<String>
- Source:
(inner) query :module:models/Query
The query to apply
Type:
- Source:
(inner) select :String
The field to be selected.
Type:
- String
- Source:
(inner) sorts :Array.<module:models/Sort>
The list of sort clauses configured for the search request. Sort clauses are optional.
Type:
- Array.<module:models/Sort>
- Source:
(inner) start :Number
The zero-based index of the first search hit to include in the result.
Type:
- Number
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/OrderSearchRequest}
Constructs a OrderSearchRequest from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/OrderSearchRequest | Optional instance to populate. |
- Source:
Returns:
The populated OrderSearchRequest instance.