Creating a Criteria Object

From within a script, use the createCriteria method on the appropriate case access class to define a reusable DQL query that can be used with findByCriteria or navigateByCriteria calls.

Method syntax Description
createCriteria(DQLString) Creates a criteria object that defines the specified DQLString as a query.

When used in a subsequent findByCriteria or navigateByCriteria call, this object will return a list of case references that match the specified criteria.

createCriteria(DQLString,index,pageSize) Creates a criteria object that defines the specified DQLString as a pre-paginated query.

When used in a subsequent findByCriteria or navigateByCriteria call, this object will return a paginated list of case references that match the specified criteria.

where:

  • DQLString is a DQL string that defines the query to be executed.
  • index is the (zero-based) number of the first record to return in a paginated list.
  • pageSize is the number of records to return in each page of a paginated list. A value of -1 means return all records.
Note: When creating a criteria object for use with a navigateByCriteria method, you must use the target case access class, not the source class. See Navigating Association Links to find Related Case Objects.