Schema Central > OAGIS® 10 > Common.xsd > ResponseCriteria
Advanced search
Need XML Help?

Recommended Reading:

Definitive XML Schema

 

Web Service Contract Design and Versioning for SOA

 

Advanced XML Applications

 

ResponseCriteria

ResponseCriteria identifies the content that is to be returned, given query success. In essence, the expression here has the effect of filtering the part(s) of the found element(s) that are to be returned.

ReturnCriteria plays no role in the query itself. That is handled as a match against the request BOD's noun exemplar. 

ReturnCriteria allows the sender of the BOD to indicate which information (down to the field level) is requested to be returned, given that the query has been successful in matching the exemplar to existing nouns. 

That is, in a GetListPurchaseOrder, if one or more PurchaseOrders with a TotalPrice = $1M were found, ReturnCriteria tells the BOD recipient which parts of the PurchaseOrder should be populated with content when the response (ShowPurchaseOrder) is formulated.

The expressionLanguage indicates the expression language being used. In order for the ReturnCriteria expression to be evaluable by the BOD recipient, the recipient must be capable of processing and interpreting the specified expression language. XPath is the default, due to its ubiquity among XML processing technologies. 

Element information

Type: ResponseActionCriteriaType

Properties: Global, Qualified, ID: oagis-id-0c7f17ab099d4cffa0819ceec2b421b7

Content

Attributes

None

Used in

Sample instance

<ResponseCriteria>
   <ResponseExpression actionCode="token">token</ResponseExpression>
   <ChangeStatus>
      <ID/>
      <IDSet>
         <ID/>
      </IDSet>
      <Code/>
      <Description/>
      <ReasonCode>normalizedString</ReasonCode>
      <Reason/>
      <EffectiveTimePeriod>
         <InclusiveIndicator>true</InclusiveIndicator>
         <StartDateTime></StartDateTime>
         <StartTime>token</StartTime>
         <Duration>P1Y2M3DT10H</Duration>
         <EndDateTime></EndDateTime>
         <EndTime>token</EndTime>
      </EffectiveTimePeriod>
      <StateChange>
         <ID/>
         <IDSet>...
         </IDSet>
         <FromStateCode>token</FromStateCode>
         <ToStateCode>token</ToStateCode>
         <ChangeDateTime></ChangeDateTime>
         <Description/>
         <Note/>
         <Extension>.......................................
         </Extension>
      </StateChange>
      <Extension>
         <AnyExtension>
            <!--any element-->
         </AnyExtension>
         <Amount/>
         <Code/>
         <DateTime></DateTime>
         <ID/>
         <Indicator>true</Indicator>
         <Measure/>
         <Name/>
         <Number>1.0</Number>
         <Quantity/>
         <Text/>
         <Time></Time>
         <ValueText>string</ValueText>
      </Extension>
   </ChangeStatus>
</ResponseCriteria>

Site developed and hosted by Datypic, Inc.

Please report errors or comments about this site to contrib@functx.com