The SQL repository allows you to filter database read operations. For example, you might want a database lookup always to return only items whose activeFlag property is true. You can filter the repository by defining a repository query that specifies the filter criteria you want and associating it with the appropriate item descriptor. The filter is then automatically applied to all of the following operations:
Repository.getItem()
Repository.getItems()
MutableRepository.getItemForUpdate()
MutableRepository.getItemsForUpdate()
RepositoryView.executeQuery()
RepositoryView.executeCountQuery()
There are three ways of defining a repository filter:
Use the
<rql-filter>tag in the definition file for an item descriptor.Set the
filterQueryproperty of the item descriptor to a Query object.Set the
rqlFilterStringproperty of the item descriptor to an RQL string, which will be compiled into the Query object that defines the filter.
In most cases, the first method, using the <rql-filter> tag, is easiest and preferable.
