Show TOC

 Query Conditions

Query-response operations typically request information about business objects of a certain type, based on selection criteria. In the request message of the query, the consumer specifies the selection criteria and the view of the business object that is the basis of the query. The result is sent back to the consumer in the response message. 

The general naming convention for query-response service operations is <BusinessObjectView>By<SelCrit>Query, where:

  • <BusinessObjectView> is a view on the business object. It defines the object type that is returned in the response message.

  • <SelCrit> is the selection criterion for the query. 

It is useful to distinguish between two types of query, qualifying and non-qualifying:

  • A qualifying query identifies a business object in a unique way by providing the ID of the object. For this purpose, a selection qualifier such as 'byID' is used.

  • A non-qualifying query is a query that does not necessarily refer to a single object. For example, the query “Select all purchase orders for a specific buyer” generally returns zero or more objects.

In the case of a non-qualifying query, the message type of the request message generally allows any number of selection criteria. That means it is possible to indicate a single value, an interval, or a range (a set of intervals). It is also possible to use single values, intervals, or ranges in parallel. 

Processing conditions are used in query-response data types that are expected to handle a large number of Business Document Object (BDO) instances. 'Query Processing Conditions’ are used to define the maximum number of ‘hits’ to be returned by a query pattern. ‘Response Processing Conditions’ define the information to be returned by a response pattern if the maximum number of hits is exceeded. Note: The use of processing conditions is optional, but where they are used the default maximum number of hits is 100.