Flexberry ORM ODataService 5.2.0-beta01
Класс NewPlatform.Flexberry.ORM.ODataService.Formatter.CustomEnableQueryAttribute

This class defines an attribute that can be applied to an action to enable querying using the OData query syntax. To avoid processing unexpected or malicious queries, use the validation settings on EnableQueryAttribute to validate incoming queries. For more information, visit http://go.microsoft.com/fwlink/?LinkId=279712. Подробнее...

Граф наследования:NewPlatform.Flexberry.ORM.ODataService.Formatter.CustomEnableQueryAttribute:

Открытые члены

override void ValidateQuery (HttpRequestMessage request, ODataQueryOptions queryOptions)
 Validates the OData query in the incoming request. By default, the implementation throws an exception if the query contains unsupported query parameters. Override this method to perform additional validation of the query. Подробнее...
 
override IQueryable ApplyQuery (IQueryable queryable, ODataQueryOptions queryOptions)
 Applies the query to the given IQueryable based on incoming query from uri and query settings. By default, the implementation supports $top, $skip, $orderby and $filter. Override this method to perform additional query composition of the query. Подробнее...
 
override object ApplyQuery (object entity, ODataQueryOptions queryOptions)
 Applies the query to the given entity based on incoming query from uri and query settings. Подробнее...
 

Подробное описание

This class defines an attribute that can be applied to an action to enable querying using the OData query syntax. To avoid processing unexpected or malicious queries, use the validation settings on EnableQueryAttribute to validate incoming queries. For more information, visit http://go.microsoft.com/fwlink/?LinkId=279712.

Методы

override IQueryable NewPlatform.Flexberry.ORM.ODataService.Formatter.CustomEnableQueryAttribute.ApplyQuery ( IQueryable  queryable,
ODataQueryOptions  queryOptions 
)
inline

Applies the query to the given IQueryable based on incoming query from uri and query settings. By default, the implementation supports $top, $skip, $orderby and $filter. Override this method to perform additional query composition of the query.

Аргументы
queryableThe original queryable instance from the response message.
queryOptionsThe ODataQueryOptions instance constructed based on the incoming request.
Возвращает
queryable
override object NewPlatform.Flexberry.ORM.ODataService.Formatter.CustomEnableQueryAttribute.ApplyQuery ( object  entity,
ODataQueryOptions  queryOptions 
)
inline

Applies the query to the given entity based on incoming query from uri and query settings.

Аргументы
entityThe original entity from the response message.
queryOptionsThe ODataQueryOptions instance constructed based on the incoming request.
Возвращает
The new entity after the $select and $expand query has been applied to.
override void NewPlatform.Flexberry.ORM.ODataService.Formatter.CustomEnableQueryAttribute.ValidateQuery ( HttpRequestMessage  request,
ODataQueryOptions  queryOptions 
)
inline

Validates the OData query in the incoming request. By default, the implementation throws an exception if the query contains unsupported query parameters. Override this method to perform additional validation of the query.

Аргументы
requestThe incoming request.
queryOptionsThe ODataQueryOptions instance constructed based on the incoming request.