IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters > Adapter Toolkit > Implementing code from the IBM WebSphere Adapter Toolkit > Data model > Business object standards > Standard processing logic

Retrieve

This operation rebuilds the complete business object hierarchy. The adapter ensures that the returned hierarchical business object matches exactly the database state of the application entity.

The Retrieve operation accepts either an after-image or delta business object. The comparison in either case will be by equality only. Non-key values are allowed as match criteria.

The request business object can contain any of the following:

The difference between Retrieve and RetrieveAll is that Retrieve is intended to return a single, unique business object that meets user-defined criteria whereas RetrieveAll returns multiple matching business objects.

For example, use Retrieve to find Customer where id="abc123" and RetrieveAll to find all Customers where state="NY".


Processing overview

Retrieve processing is as follows:

When the retrieve operation is invoked, it is preferable to retrieve the record information from the EIS and put it into the output structured record, where getNext() will populate that information into the output cursor. If it is not possible to retrieve the information from the EIS until getNext() is called, it is acceptable to perform the entire retrieve operation inside of the getNext() method.


Error handling

RecordNotFoundException is thrown if any populated properties in the input business object does not exist in the EIS.

MultipleMatchingRecordsException is thrown if more than one record match input criteria.

EISSystemException is thrown if the EIS reports any unrecoverable errors.

Standard processing logic