List

In an effort to simpilify the usage of the verbs the List verb is being deprecated as of OAGIS 9.0, the List will still be provided for the next three releases at which time it is scheduled to be removed from OAGIS.  As such for all new development we recommend that you use the Show verb which may serve the same function of the List verb has in the past.


The purpose of the List verb is to enable a business software component to respond to a GetList request or to proactively send a listing of summary information containing many instances of occurrences of data for a noun to one or more other business software components.The results of a List may then be used as is, or they may be used to select a specific instance of a document or entity in order to issue a detail Get request.Although BODs based on this verb do not commonly cause updates to occur, there may be times when the component receiving the List decides to use the information it receives to update.  This is entirely the decision of the receiving software component and is not forbidden.The behavior of the List verb is quite straight forward with a few exceptions.  The List response to any GetList request needs to read the request carefully to ensure the response is returning the requested Data Types. The List needs to ensure the response to the GetList does not exceed the maxItems value.The List needs to find the specific Field Identifiers that are used for the Field-Based Selection or Range-Based Selection and process them accordingly.

The attributes associated with the List BODs are as follows:
o	rsstart attribute is a number that idicates the starting record for the section of the resulting set returned in the list message. This value should always match the rsstart value in the originating GetList BOD.
o	rscount attribute is a number that indicates the number of records returned in the message. The subsequent request for additional records should have a rsstart value of rscount + 1.
o	rstotal attribute is a number that indicates the total number of records in the result set.
o	rscomplete attribute is a Boolean that indicates that the list provided exhaust the possible values.
o	rsref attribute is a string that represents the implementation-specific result set identifier for subsequent requests.
			

See http://www.openapplications.org/oagis/9.0.

Element information

Content

from type ResponseVerbType
Sequence [1..1]
1. OriginalApplicationArea [0..1]    A copy of the ApplicationArea for the original BOD that was processed. Present either as additional reference information, or for use in identifying the BOD in situations where a BODReference is not known.
2. ResponseCriteria [0..*]    ResponseCriteria identifies the content that is returned, given a Get query success or the response from the Process. 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 or the process. 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.

Attributes

Used in

• Type ListActualLedgerDataAreaType (Element DataArea)
• Type ListBOMDataAreaType (Element DataArea)
• Type ListInventoryCountDataAreaType (Element DataArea)
• Type ListItemMasterDataAreaType (Element DataArea)
• Type ListMaintenanceOrderDataAreaType (Element DataArea)
• Type ListPickListDataAreaType (Element DataArea)
• Type ListProductionOrderDataAreaType (Element DataArea)
• Type ListPurchaseOrderDataAreaType (Element DataArea)
• Type ListQuoteDataAreaType (Element DataArea)
• Type ListRFQDataAreaType (Element DataArea)
• Type ListReceiveDeliveryDataAreaType (Element DataArea)
• Type ListRequisitionDataAreaType (Element DataArea)
• Type ListRoutingDataAreaType (Element DataArea)
• Type ListSalesOrderDataAreaType (Element DataArea)
• Type ListUOMGroupDataAreaType (Element DataArea)

Sample instance

<List>
   <OriginalApplicationArea>
      <Sender>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <TaskID>normalizedString</TaskID>
         <ReferenceID>normalizedString</ReferenceID>
         <ConfirmationCode>Always</ConfirmationCode>
         <AuthorizationID>normalizedString</AuthorizationID>
      </Sender>
      <Receiver>
         <LogicalID>normalizedString</LogicalID>
         <ComponentID>normalizedString</ComponentID>
         <ID>normalizedString</ID>
      </Receiver>
      <CreationDateTime>2000-01-01</CreationDateTime>
      <Signature>
         <!--any element-->
      </Signature>
      <BODID>normalizedString</BODID>
      <UserArea>
         <!--any element-->
      </UserArea>
   </OriginalApplicationArea>
   <ResponseCriteria>
      <ResponseExpression actionCode="Accepted">token</ResponseExpression>
      <ChangeStatus>
         <Code>normalizedString</Code>
         <Description>string</Description>
         <EffectiveDateTime>2000-01-01</EffectiveDateTime>
         <ReasonCode>normalizedString</ReasonCode>
         <Reason>string</Reason>
         <StateChange>...
         </StateChange>
         <UserArea>
            <!--any element-->
         </UserArea>
      </ChangeStatus>
   </ResponseCriteria>
</List>