getResourceOrderFilterCriteria

This request returns the default sort and filter criteria that are defined on the server for the currently logged on user. These criteria are used to display work item lists for a user before a custom filter and sort are specified in the application.

The default sort and filter criteria can be set in a number of ways:

  • AMX BPM API calls - There are API calls that allow the sort and filter criteria on the server to be set for a resource. For information, see the TIBCO ActiveMatrix BPM Developer’s Guide.
  • Use the setResourceOrderFilterCriteria request - See setResourceOrderFilterCriteria.
  • When the Open Next Work Item function is used. This function always uses the sort and filter criteria on the server to determine the next work item in the list. Therefore, whenever you select the Open Next Work Item function, a comparison is made between the currently defined sort and filter in the work item list, and the sort and filter specified on the server. If they are the same, the function uses that definition to determine the next work item. If they differ, the sort and filter specified in the current work item list is written to the server, resulting in a new default sort and filter defined on the server. The Open Next Work Item function then uses that sort and filter to determine the next work item to open.

Syntax

com.tibco.wcc.base.Requests.getResourceOrderFilterCriteria(requestId);

Parameters

requestId - (String) Uniquely identifies the request. For more information, see Submitting Server Requests.

Returns

Returns an <ap:OrderFilterCriteria> element, which contains the following elements:

  • <ap:Filter> - The default filter expression stored on the server.
  • <ap:Sort> - The default sort expression stored on the server.

For example:

<ap:Requests>
  <ap:OrderFilterCriteria Id="ApiSample.getResourceOrderFilterCriteria">
    <ap:Filter>startDate &lt; 2011-03-04T00:00:00.000-08:00</ap:Filter>
    <ap:Sort>startDate ASC, priority DESC</ap:Sort>
  </ap:OrderFilterCriteria>
</ap:Requests>