Obj-Filter method
Use the Obj-Filter method to filter the embedded pages of a results page (such as a Code-Pega-List page produced by the RDB-List, Obj-List-View or Obj-Browse methods) based on one or more when condition rules.
For example, if each embedded page on results page contains a
Page List
property Child and each Child page contains a
Single Value
property
FirstName, you can use the Obj-Filter method to remove all embedded pages where no value of
FirstName is "Robert".
Parameters
This method has two required parameters and an array parameter.
| Parameter | Description |
| ListPage | Name of the results page, of class Code-Pega-List. |
| ResultClass | Select the Applies To key part of one or more when condition rules ( Rule-Obj-When ) to be used to test each result. Must match or be an ancestor class of the class of the embedded pages in the ListPage page. |
| When | Complete at least one row of this array, specifying a when condition rule. Enter the second key part ( When Name ) of a when condition rule. Typically, the comparisons and expressions in the when condition rule involve one or more aggregate properties or unexposed properties. |
Results
At run time, the system uses rule resolution to find the when condition rules.
Use the Obj-Filter method to filter the embedded pages of a results page (such as a Code-Pega-List page produced by the RDB-List, Obj-List-View or Obj-Browse methods). When one or more when rules evaluate to false, the page is removed from the results page.
The embedded pages for which all when condition rules evaluated to true are not affected.
The contents of surviving embedded pages are not affected.
Checking the method status
This method updates the pxMethodStatus property. See How to test method results using a transition.
Previous topic Obj-Delete-By-Handle method Next topic Obj-List-View method