Class: SavedSearchAPI

SavedSearchAPI

A SavedSearchAPI provides the following configuration properties in Process Designer:
Behavior
Search Organized By: {By Task | By Instance} string
Events
On Load:
Description: This event is triggered when the control is loaded.
Example:
On Request Complete:
Description: This event is triggered when a request is complete.
Example:
On Request Error:
Description: This event is triggered when there is a request error.
Example:

new SavedSearchAPI()

This constructor is never used explicitly.

Extends

  • com.ibm.bpm.coach.CoachView

Methods

Get the result
Returns:
Type Description
object
Get the type
Returns:
Type Description
string

querySavedSearch(searchName, query)

Get the saved search. Results are stored in control and can be accessed through getResult.
Name Type Description
searchName string
query string optional

querySavedSearchAttributes(searchName, includeTaskData)

Get the attributes of the saved search. Results are stored in control and can be accessed through getResult.
Name Type Description
searchName string the assigned name that you are searching for
includeTaskData boolean

querySavedSearchCount(searchName, query){integer}

Get the saved search count
Name Type Description
searchName string
query string
Returns:
Type Description
integer

querySavedSearches(matchColumns)

Get the saved search which matches a specific column. Results are stored in control and can be accessed through getResult.
Name Type Description
matchColumns string | Array.<string> optional columns to match