'Declaration
 
<NotNullAttribute()>
Public Function GetJobTree( _
   ByVal baseGroupOID As OID, _
   ByVal recursive As Boolean, _
   ByVal includeGroups As Boolean, _
   ByVal includeJobs As Boolean _
) As JobGroup

[NotNull()]
public JobGroup GetJobTree( 
   OID baseGroupOID,
   bool recursive,
   bool includeGroups,
   bool includeJobs
)

[NotNull()]
public:
JobGroup^ GetJobTree( 
   OID^ baseGroupOID,
   bool recursive,
   bool includeGroups,
   bool includeJobs
) 

Parameters

baseGroupOID

The OID of the JobGroup to use as the starting point for the tree. Use ArcanaDevelopment.adTempus.Shared.WellKnownOIDs.RootGroup to return all groups and jobs on the server.

recursive

If true, works recursively to return all levels of group below the starting point. If false, only information about the group represented by baseGroupOID and its jobs is returned.

includeGroups

Specifies whether child groups should be returned

includeJobs

Specifies whether jobs should be returned

This method is intended to be used for listing jobs and groups in the user interface. It returns stubs for the groups and jobs, which contain only minimal descriptive information and not full properties and relations (see Remarks).

JobGroups returned by this method also have several properties set that are not otherwise returned by the server:

• JobGroup.ActiveJobs
• JobGroup.FailedJobs
• JobGroup.WarningJobs
• JobGroup.GetInstanceCounts

Object Stubs

When you only need to display basic information about an object you can reduce the amount of data being returned from the server by fetching the object as a "stub," which contains only minimal information such as description (as returned by ObjectBase.GetDescription) and permissions. A stub object has ObjectBase.IsStub set to true. If you access a property or relation that was not returned as part of the stub, the client will automatically fetch the full object details from the server.

To fetch object stubs instead of full objects Include the ArcanaDevelopment.adTempus.Shared.ObjectFetchOptions.StubsOnly flag when calling any method that accepts an ArcanaDevelopment.adTempus.Shared.ObjectFetchOptions parameter.

Reference

DataContext Class
DataContext Members