WebSphere Message Brokers
File: csba_retrieveall
Writer: Karen Cameron

Concept topic

This build: July 31, 2007 21:40:33

RetrieveAll

The adapter supports the RetrieveAll operation request, even when non-keys are set on the primary business component. When none of the attributes are set, an asterisk (*) is selected.

If the values of the attributes, which are part of the search criteria, contain an asterisk (*), it is treated as a RetrieveAll for that attribute. Any additional search criteria is applied if it is present.

The returned business object is a container business object of the business graphs.

The steps involved in processing the RetrieveAll operation is similar to the Retrieve operation, except the check is not made to see whether all the keys are set in the incoming WebSphere Business Integration adapter business object.

Note:

The adapter can process the values of the attributes contained in the special characters, which include ‘(‘, ‘)’, “””, “’”, “,”,”-“,”<”,”>”. Only these special characters are processed by the adapter. This applies to all the operations.

It is important to note that the number of records that the adapter can return cannot exceed the MaxRecords property value of the WBIInteractionSpec property instance. If the number of records retrieved from the enterprise information system exceeds the MaxRecords property value, the exception, MatchesExceededLimitException, is thrown. In addition, if no records are retrieved, the exception, RecordNotFoundException, is thrown.

Business service support

The business object is processed during outbound calls by processing the properties of the top-level object. Each business object property that is marked as an input property is used in the method invocation on the Siebel business service, if that property is set in the business object instance.

The Siebel message container, which represents an integration object, is also processed. This object consists of the attributes and metadata necessary to create the Siebel property sets (PropertySets) that are required during business service execution.

The results of the business service execution are Siebel property sets (PropertySets) and, or, simple types. These values are then placed in their corresponding output business object properties in the top-level object. The Siebel message-container business object is populated by the corresponding child property set (PropertySet). The child property set is traversed, and the object is populated, by using the metadata and field names specified in the result. The Siebel message-container business object is populated with the obtained property set. The returned output property set is based on the status keys defined in the integration object. Only those particular fields are present in the output property set.

For Example, in the case of an integration object account interface and the account integration component beneath, one status key is defined and the fields for that key are defined. The defined fields include Account Id, Integration Id, and operation. The output property set contains values for only those fields. The entire business graph is then returned to the client after being populated with the results from the business service execution.

Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:40:33

csba_retrieveall This topic's URL is: