DataObjectApiQuery Class

Represents the ActualData Object query which is performed on Database Collection directly.

Inheritance Hierarchy

SystemObject
Casewhere.Runtime.DSL.ApiDataApiQuery
Casewhere.Runtime.DSL.ApiDataObjectApiQuery

Namespace: Casewhere.Runtime.DSL.Api
Assembly: Casewhere.Runtime (in Casewhere.Runtime.dll) Version: 2.8.1.0

Syntax

Copy

public class DataObjectApiQuery : DataApiQuery

The DataObjectApiQuery type exposes the following members.

Properties

	Name	Description
	DataClassName	The ActualData Class name.
	Filter	The filter object that is built using FilterBuilder. (Inherited from DataApiQuery.)
	IncludeTotal	Determines whether Casewhere returns the total number of ActualData Objects. (Inherited from DataApiQuery.)
	ProjectedFields	The list of fields returned to Client. By default, Casewhere will return all. (Inherited from DataApiQuery.)
	SearchLimit	When the limit is set, Casewhere will only process the search result within that limit, even when more data is found. If the limit is not set, Casewhere will use the SearchLimit configured in the web.config. This limit is applied for full-text search only. (Inherited from DataApiQuery.)
	Skip	Bypasses a specified number of elements in a sequence and then returns the remaining elements. By default, Casewhere will skip none. (Inherited from DataApiQuery.)
	SortedFields	List of sort fields. (Inherited from DataApiQuery.)
	Take	Determines the number of ActualData Objects returned. By default, Casewhere will take all. (Inherited from DataApiQuery.)

Top

Methods

	Name	Description
	FilterBy(DynamicFilter)	Set query filter. For chaining purpose.
	FilterBy(Object)	Set query filter. For chaining purpose.
	For	Creates the query object.
	IncludeTotalItems	Determines whether Casewhere returns the total number of ActualData Objects. For chaining purpose.
	LimitSearch	When the limit is set, Casewhere will only process the search result within that limit, even when more data is found. If the limit is not set, Casewhere will use the SearchLimit configured in the web.config. This limit is applied for full-text search only.
	OrderBy	Set query sorting. For chaining purpose.
	Paging	Set query paging. For chaining purpose.
	ProjectOn	Set query projection. For chaining purpose.
	ToRuntimeQuery	Convert DataObjectApiQuery to PagedDataObjectQuery. Ensure ProjectedFields has Id.

Top

Examples

Copy

var filter = FilterBuilder.Create().Eq("DepartmentId", ctx.Input.Id).Eq("Active", true).Build();
var query = DataObjectApiQuery.For("Employee")
    .FilterBy(filter)
    .ProjectOn("Username", "DepartmentId")
    .OrderBy("Firstname", true)
    .Paging(0, 10);
var result = ctx.Use<IDataApi>().Search(query);

Reference

Casewhere.Runtime.DSL.Api Namespace