RetrieveAll operation

This operation enables the adapter to retrieve an array of business objects from the database.

All of the key and non-key attributes populated in the incoming business object determine the selection criteria. The adapter may retrieve multiple rows for the top-level business object from the database, depending on the attributes selected. If no attributes are populated in the incoming business object, all the rows are retrieved from the respective table in the database.

The adapter performs the following steps to retrieve an array of business objects:
  1. For each of the rows retrieved from the database, the adapter constructs a top-level business graph and creates a container of business graphs using all of the retrieved rows. The name of the container business graph is BOName + ContainerBG.
  2. The adapter retrieves each of the business graphs in the container using the retrieve operation.

The following figure describes the structure of the business object that is returned in a RetrieveAll operation.

This figure has a box at the top titled CustomerContainerBO. From this box a line extends downward. The line has two branches extending to the right. The first branch has two boxes connected by a line. The first box is titled CustomerBG and the second is Customer. A line extends downward from the Customer box to a box titled Address BO. The second branch has the same configuration as the first branch.

The following errors can result from a RetrieveAll operation:
  • If any populated business object in the input object does not exist in the EIS, the adapter returns the error RecordNotFoundException.
  • If the number of hits in the EIS exceeds the value of ResultSetLimit defined in the interaction specification, the adapter returns the error MatchesExceededLimitException. The MatchCount property contains the actual number of hits that the adapter had in the EIS, so that you can either increase the limit, or refine the search appropriately.
    Note: If ResultSetLimit is set to a very large number, problems may occur related to a lack of sufficient memory, depending upon the size and number of business objects returned.
  • If any unrecoverable errors are reported by the EIS, the adapter returns the error EISSystemException.

Terms of use |

Last updated: Thu Mar 23 13:24:31 2006

(c) Copyright IBM Corporation 2005.
This information center is powered by Eclipse technology (http://www.eclipse.org)