(r7) ResourceQuery < Main

This wiki is locked. Future workgroup activity and specification development must take place at our new wiki. For more information, see this blog post about the new governance model and this post about changes to the website.

TWiki>

Main Web>MainOslcCommonArchitecture>ReportingHome>ResourceQuery (revision 7) (raw view)

---+ Resource Query

This document specifies the Query features that a Service Provider needs to implement on top of a domain specification for Reporting. The Reporting Consumer will base on this specification for their expectation of the Query features supported by a Service Provider on Reporting.

This document only makes references to the [[OslcQuery][Query Specification]] as defined in the OSLC Core Specification (hereafter will be referred as OSLC Query Specification). The actual specification of the Query is defined in the OSLC Core Specification and won't be repeated in this document.

This document may tighten the constraints as specified in the OSLC Query Specification, but will not relax them.

---+++ Query Requirements

Based on the ReportingUseCases, the following requirements are identified for resource query.
   1 Getting data on a list of resources of the same type and their properties. 
      * identify a subset of the properties of the resource that the Reporting Consumer is interested in.
      * optionally, specify a filter based on the resource property values to constrain the data coming back.
      * optionally, specify a sort based on the resource property values to order the sequence of the data coming back.
   1 Getting data on a resource and its property. 
      * identify a subset of the properties of the resource that the Report Consumer is interested in.
---+++ Query Specification for Reporting<a name="spec" title="spec"></a>

Use Case:
   1 ETL
   1 Live Reporting
   1 Document Generation
Proposal: <br /> 
   1 Service Provider MUST support query that returns a default set of properties. 
      1 all properties of a resource as described by the Resource Shape Resource (support oslc.properties=*) [use case 2, 3]
      1 all properties of a resource as described by the Resource Shape Resource for all the resources in a collection (support oslc.select=*) [use case 1, 2, 3]
   1 Service Provider SHOULD support oslc.properties, oslc.select. [use case 1, 2, 3]
   1 Service Provider SHOULD support oslc.where. [use case 1, 2, 3]
   1 Service Provider SHOULD support oslc.orderBy. [use case 2, 3]
   1 Service Provider SHOULD support oslc.prefix. [use case 1, 2, 3]
   1 Service Provider SHOULD support oslc.limit. [use case 2, 3]
   1 Service Provider MAY support oslc.offset.
   1 Service Provider MUST support paging. [use case 1, 2, 3]
   1 OSLC Resources SHOULD have a property dc:modified for modification timestamp.Reporting Consumer will use this property in oslc.where to effect delta loading for the data warehouse use case. [use case 1]
   1 Service Provider MUST respond with error if any of the query parameters in the request (from Consumer) is not supported.
   1 How the Reporting Consumer handles error is not specified by this document and left to the Reporting Consumer to decide. One possible scenario is : 
      * Send request with MUST, SHOULD, MAY parameters
      * if error, send request with MUST, SHOULD parameters
      * if erro, send request with MUST parameters

---++ Comments

Add your comments here:

&gt;<cite>&gt; it (SHOULD/MAY?) support oslc.orderBy. (Question: what is the behavior if oslc.orderBy is receieved by not supported?) </cite><br /> The service provider should throw an error specifying that orderBy is not supported. Failing to do so could lead to user failing to observe the document is not sorted as expected.

-- Main.DragosCojocari - 01 Mar 2010 
%COMMENT%

Topic revision: r7 - 08 Mar 2010 - 16:24:10 - TackTong

Main

Webs
Main
Sandbox
TWiki

Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use
Ideas, requests, problems regarding this site? Send feedback