adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetJobGroups Method / GetJobGroups(String,ObjectFetchOptions,Int32,Boolean) Method
The fully-qualified name of the group to fetch (see Remarks). Specify a null reference (Nothing in Visual Basic) or an empty string to get the root group.
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
    GetJobGroups(String,ObjectFetchOptions,Int32,Boolean) Method
    In This Topic
    Gets the Job Groups with the specified name.
    Syntax
    'Declaration
     
    
    <NotNullAttribute()>
    Public Overloads Function GetJobGroups( _
       ByVal groupName As String, _
       ByVal fetchOptions As ObjectFetchOptions, _
       ByVal pageSize As Integer, _
       ByRef restartPaging As Boolean _
    ) As JobGroupCollection

    Parameters

    groupName
    The fully-qualified name of the group to fetch (see Remarks). Specify a null reference (Nothing in Visual Basic) or an empty string to get the root group.
    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.

    Return Value

    The matching Job Groups
    Remarks

    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.

    If the group is contained in a parent group, the full path to the group must be included in the form "Group Level 1\Group Level 2\Group Level 3" (to fetch the group "Group Level 3".
    See Also