overrideFilterOnRefresh

This method is called whenever a list is initially opened, each time the list is refreshed, and each time the user specifies a filter in the Filter dialog. It provides a means for always appending a filter expression to any filters that may be defined by the user.

Filter changes applied by this method do NOT appear in the Filter dialog and are not visible to the user. To prevent users from defining a filter, remove access to "Filter" in userAccess.xml.

Syntax

classProto.overrideFilterOnRefresh = function(oValue, oContext)

Parameters

  • oValue - (Object) An object containing the following properties, defining the base filter:
    • oValue.filter - (string) The filter expression to apply to the view. For information about viewing filter expressions on the Filter dialog in a WCC application, see Callout Utilities. For additional details about filter expressions, see the “Sorting Lists" and "Filtering Lists” topic in the TIBCO ActiveMatrix BPM Developer’s Guide.
    • oValue.userChanged - (boolean read-only) A flag indicating whether or not the user has ever modified the value, facilitating logic related to default values. This value is null if it is unknown whether the user has changed the value because the view was created prior to implementation of the callout interface.
  • oContext - (Object) An object that provides information about the list being modified with the following properties:
    • oContext.userName - (string read-only) The name of the logged-in user.
    • oContext.userGuid - (string read-only) A unique identifier for the logged-in user.
    • oContext.viewType - (string read-only) The view type of the list. The possible values are:
      • com.tibco.wcc.base.ListContainer.WORKVIEW (Work View)
      • com.tibco.wcc.base.ListContainer.PTVIEW (Process View)
      • com.tibco.wcc.base.ListContainer.EVENTVIEW (Event View)
    • oContext.viewName - (string read-only) The name of the view that created the list.
    • oContext.viewDescription - (string read-only) A description of the view.
    • oContext.isSystemView - (boolean read-only) True if the view is a system view; False if the view is a user-defined view.

Returns

The modified oValue object, or null if no changes are to be made.