adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetJobs Method / GetJobs(JobFetchFilter,ObjectFetchOptions,Int32,Boolean) Method
Criteria to filter the jobs to be returned
Options that control the fetch operation
The maximum number of records to retrieve in one call. See Remarks.
Indicates whether to fetch the first page or continue paging. See Remarks.


In This Topic
    GetJobs(JobFetchFilter,ObjectFetchOptions,Int32,Boolean) Method
    In This Topic
    Gets jobs from the server.
    Syntax
    'Declaration
     
    
    <NotNullAttribute()>
    Public Overloads Function GetJobs( _
       ByVal fetchCriteria As JobFetchFilter, _
       ByVal fetchOptions As ObjectFetchOptions, _
       ByVal pageSize As Integer, _
       ByRef restartPaging As Boolean _
    ) As JobCollection

    Parameters

    fetchCriteria
    Criteria to filter the jobs to be returned
    fetchOptions
    Options that control the fetch operation
    pageSize
    The maximum number of records to retrieve in one call. See Remarks.
    restartPaging
    Indicates whether to fetch the first page or continue paging. See Remarks.
    Remarks
    If the job is contained in a group, the full path to the job must be included in the form "Group Level 1\Group Level 2\Job Name". For a job in the root group, specify "\Job Name". To search all groups, specify only the name (e.g., "Job Name").

    Paging

    This method supports paged retrieval for scenarios where the amount of data returned by a fetch of all objects is not feasible for performance reasons.

    To begin a paged fetch, set the pageSize to the desired number of records per page, and set restartPaging to true to start the fetch from the first record. On return, restartPaging will be set to false if there are more records to return. Continue to call the method with restartPaging set to false until it is true on return. At this point, all available records have been returned.

    Note that there is no way to specify the page at which the retrieval should begin; fetching is sequential only.

    See Also