PFQuery Class |
Inheritance HierarchyNamespace: Packflow.Core
Assembly: MicaSystems.Packflow.Core (in MicaSystems.Packflow.Core.dll) Version: 1.0.0.0 (3.2.0.306)
Syntax[DataContractAttribute] public sealed class PFQuery
The PFQuery type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | Aggregations |
Gets or sets the list of aggregations.
When used without groups in a query, one PFGroupedObject is returned containing aggregations of all objects. When used with groups in a query, each returned PFGroupedObject will contain these aggregations. |
| CustomFields |
Gets or sets the list of custom fields, impacting which values are selected.
Important: the use of this list depends on the value of FieldsMode. |
| EnablePaging |
Gets or sets a value indicating whether paging is active.
If true, PageSize and PageNo are used. Default value: false. |
| FieldsMode |
Gets or sets a value specifying how a query should determine which values are selected as output.
|
| Groups |
Gets or sets the list of groups.
If used, the query will return grouped objects with aggregated values, instead of targeted objects. |
| Orders |
Gets or sets the list of sorting rules.
|
| PageNo |
Gets or sets the page number.
One-based index.
Only used if EnablePaging is set to true. |
| Pages |
Gets or sets the number of pages to return.
This setting is not persisted. Only used if EnablePaging is set to true. |
| PageSize |
Gets or sets the page size.
Only used if EnablePaging is set to true. |
| PagingIncludeNextResult |
Gets or sets a value indicating whether this query can include the first result of the next page, if any.
This allows to know easily if there is a next page. Only used if EnablePaging is set to true. |
| ResultsLimit |
Gets or sets the maximum number of elements that can be returned by this query.
Only used if EnablePaging is set to false. |
| ResultsScope |
Gets or sets the scope of the query, specifying which kind of objects is concerned by the query.
|
| ResultsSkip |
Gets or sets the number of elements to bypass. Following elements are returned.
Only used if EnablePaging is set to false. Default value: 0 (no element skipped). |
| RootNode |
Gets or sets the root node of the filters tree.
|
| UseBulkMode |
Gets or sets a value indicating whether the bulk mode must be used.
The bulk mode is generally used in situations where RLS can be very restrictive on large amount of data. The bulk mode will filter results using the query filters first, and RLS only after. This mode will also use a cache for RLS information. |
Methods| Name | Description | |
|---|---|---|
 | AddAggregation |
Adds a new aggregation.
|
| AddFilter(PFQueryFilter) |
Adds a new filter in the root node of filters tree.
|
| AddFilter(String, Object) |
Adds a new filter in the root node of filters tree.
|
| AddFilter(String, PFQueryFilterOperator, Object) |
Adds a new filter in the root node of filters tree.
|
| AddGroup |
Adds a new group.
|
| AddOrder |
Adds a new sorting rule.
|
| ChangeOrder(String) |
Resets orders and adds a new order.
|
| ChangeOrder(String, PFQueryOrderType) |
Resets orders and adds a new order.
|
| CheckFieldsAvailability |
Checks if the fields used in this query are available in the specified parent, given a list of available fields.
|
| ChooseFields(PFQueryFieldsMode) |
Changes the way this query should determine which values are selected as output.
|
| ChooseFields(PFQueryFieldsMode, ListString) |
Changes the way this query should determine which values are selected as output.
|
| ChooseFields(PFQueryFieldsMode, String) |
Changes the way this query should determine which values are selected as output.
|
 | CreateQuery |
Creates a new instance of the PFQuery class.
|
| CreateQuery(String) |
Creates a new instance of the PFQuery class from a serialized PFQuery.
|
| CreateQuery(PFQueryFilter) |
Creates a new instance of the PFQuery class, with default filters.
|
| CreateQuery(PFQueryFilter, PFQueryOrder) |
Creates a new instance of the PFQuery class, with a default filter and a default order.
|
| CreateQueryFilter(String, Object) |
Creates a new instance of the PFQuery class, with a default filter.
|
| CreateQueryFilter(String, PFQueryFilterOperator, Object) |
Creates a new instance of the PFQuery class, with a default filter.
|
| CreateQueryFilter(String, Object, String) |
Creates a new instance of the PFQuery class, with a default filter and a default order.
|
| CreateQueryFilter(String, PFQueryFilterOperator, Object, String) |
Creates a new instance of the PFQuery class, with a default filter and a default order.
|
| CreateQueryFilter(String, Object, String, Boolean) |
Creates a new instance of the PFQuery class, with a default filter and a default order.
|
| CreateQueryFilter(String, PFQueryFilterOperator, Object, String, Boolean) |
Creates a new instance of the PFQuery class, with a default filter and a default order.
|
| CreateQueryOrderBy(String, PFQueryFilter) |
Creates a new instance of the PFQuery class, with default filters.
|
| CreateQueryOrderBy(String, Boolean) |
Creates a new instance of the PFQuery class, with a default order.
|
| CreateQueryOrderBy(String, Boolean, PFQueryFilter) |
Creates a new instance of the PFQuery class, with a default order and multiple default filters.
|
| GetACopy |
Copies this PFQuery using serialization.
|
| GetAggregationsFields |
Gets the names of all fields/columns used in aggregations.
|
| GetAllFilters |
Gets all filters in the filters tree, recursively.
|
| GetGroupsFields |
Gets the names of all fields/columns used in groups.
|
| GetNextResultsCount |
Returns 1 if PagingIncludeNextResult is true, 0 otherwise.
|
| GetOrderFields |
Gets the names of all fields/columns used in sorting rules.
|
| GetSubGroupQuery(KeyValuePairString, Object) |
Creates a new PFQuery object retrieving values of a particular group.
The new query will replace one level of group by a filter on the same field. E.g. a gridview displaying groups will call this method to obtain the query to execute when one of the groups is opened. |
| GetSubGroupQuery(ListKeyValuePairString, Object) |
Creates a new PFQuery object retrieving values of a particular group.
The new query will replace one level of group by a filter on the same field. E.g. a gridview displaying groups will call this method to obtain the query to execute when one of the groups is opened. |
| OrderBy |
Starts to build a new query.
Adds a new sorting rule.
|
| OrderByDescending |
Starts to build a new query.
Adds a new sorting rule.
|
| Select |
Starts to build a new query.
Changes the way the query should determine which values are selected as output.
|
| Serialize |
Serializes this PFQuery in XML.
The returned string can be converted into a PFQuery using the static method PFQuery.CreateQuery(serializedQuery). |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Where(String, Object) |
Starts to build a new query.
Adds a new filter in the root node of filters tree.
|
| Where(String, PFQueryFilterOperator, Object) |
Starts to build a new query.
Adds a new filter in the root node of filters tree.
|
| WhereIsNotNull |
Starts to build a new query.
Adds a new filter in the root node of filters tree.
|
| WhereIsNull |
Starts to build a new query.
Adds a new filter in the root node of filters tree.
|
Extension Methods| Name | Description | |
|---|---|---|
 | AsT |
Casts an object to another type. Returns default(T) if the object is null.
(Defined by Utils_Other.) |
| EqualsAll |
Checks that this object is equal to every object in parameters.
(Defined by Utils_Other.) |
| EqualsAny |
Checks that this object is equal to at least one of the parameters.
(Defined by Utils_Other.) |
| GetString |
Converts an object to String using ToString() method, else returns String.Empty.
(Defined by Utils_Other.) |
| IsGenericList | Overloaded.
Checks if this object is a System.Collections.Generic.List.
(Defined by Utils_Linq.) |
| IsGenericList(Type) | Overloaded.
Checks if this object is a System.Collections.Generic.List using type as T.
(Defined by Utils_Linq.) |
| Serialize | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| Serialize(String) | Overloaded.
Serializes an object into an XML document.
(Defined by Utils_Xml.) |
| SerializeJson | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(ListType) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
| SerializeJson(DataContractJsonSerializerSettings) | Overloaded.
Serializes an object using a DataContractJsonSerializer.
(Defined by Utils_String.) |
See Also