adTempus API
PreviousUpNext
IObjectRequestFilter Interface

Interface implemented by objects that define server-side filtering for object selection.

C++
__interface IObjectRequestFilter : IDispatch;
C#
public interface IObjectRequestFilter : IDispatch;
Visual Basic
Public Interface IObjectRequestFilter
Inherits IDispatch

Implement the IObjectRequestFilter interface to provide server-side filtering of objects through the Scheduler.CountObjectsWhere and Scheduler.GetObjectsWhere methods.

The API includes two predefined filter objects for filtering execution instances (IJobHistoryFilter) and message log events (ILogFilter). 

You must implement the four methods of the interface, which return pieces of the SQL selection statement needed to retrieve records.

The following example illustrates the syntax that must be used for the string returned by each method. 

Assume that you are creating a filter object that returns all jobs for user ID "someuser", ordered by the job name. The SQL selection statement for this would be: 

 

SELECT * FROM job WHERE userID='someuser' ORDER BY name

 

The methods of your filter object would return the following strings: 

 

job 
userID='someuser' 
name 
adTempus API Reference version 3.0.0.0, revised 10/30/2008