Required Parameter Group:
| 1 | Object description information | Input | Char(*) |
| 2 | Media information | Input | Char(*) |
| 3 | Control value information | Output | Char(*) |
The BRMS Object Retrieval Exit Program provides the capability of retrieving objects saved using *FREE by BRMS. The exit program, if registered to the exit point, will only be called when the retrieve confirmation within BRMS is *VERIFY.
The user exit program is called each time a suspended object is accessed by an i5/OS operation and BRMS has determined that an archive version of the object is to be restored to the system to satisfy the i5/OS request. This exit will give the user exit program a chance to influence the decision to restore the object as well as provide a custom interface tailored to individual needs.
When the user exit program is given control, it makes the decision as to what continued action should be taken for the suspended object. The exit program returns the appropriate control value information to BRMS indicating either to follow the normal retrieval rules defined to BRMS, to recall immediately, to delay restore to a later time, to submit the restore to batch, or to cancel the restore of the object.