Navigating Association Links to find Related Case Objects
From within a script, methods are provided that you can use to navigate association links from the referenced case object to find related case objects.
Note: You can only use these methods to navigate existing
association links. If you try to navigate using a link that either has not been created yet or has been deleted, execution of the script will fail.
The following shows the navigation methods that are available.
| Method | Description |
|---|---|
| navigateAll(caseRef, associationLinkName, fromIndex, pageSize) | Returns a list of case references linked to the supplied case. |
| navigateByCriteria(caseRef, associationLinkName, DQL, fromIndex, pageSize) | Returns a list of case references linked to the supplied case that match the DQL search string. |
| navigateBySimpleSearch(caseRef, associationLinkName, searchString, fromIndex, pageSize) | Returns a list of case references linked to the supplied case that match the search string. |
where:
- caseRef - The case reference to search from.
- associationLinkName - The field name linking the cases to return.
- DQL - The Data Query Language (DQL) search string.
- searchString - The search string.
- fromIndex - The first item to return -- zero based.
- pageSize - The number of items to return.
Subtopics