adTempus API
ArcanaDevelopment.adTempus.Client Namespace / DataContext Class / GetJobChain Method
The OIDs to fetch. See Remarks.
If specified, only jobs participating in the specified chain are returned.


In This Topic
    GetJobChain Method (DataContext)
    In This Topic
    Gets the requested jobs and all jobs linked to them through Conditions, Responses, and Triggers.
    Syntax
    'Declaration
     
    
    <NotNullAttribute()>
    Public Function GetJobChain( _
       ByVal oids As IEnumerable(Of OID), _
       ByVal chainID As Nullable(Of Guid) _
    ) As JobLinkResults
    [NotNull()]
    public JobLinkResults GetJobChain( 
       IEnumerable<OID> oids,
       Nullable<Guid> chainID
    )
    [NotNull()]
    public:
    JobLinkResults^ GetJobChain( 
       IEnumerable<OID^>^ oids,
       Nullable<Guid> chainID
    ) 

    Parameters

    oids
    The OIDs to fetch. See Remarks.
    chainID
    If specified, only jobs participating in the specified chain are returned.
    Remarks

    GetJobChain returns all jobs that are linked to the requested jobs, directly or indirectly, through JobConditions, JobControlActions, and JobTriggers.

    For example, if this job is called by a Response in JobA, and JobA has a condition on JobB, GetJobChain returns this job, JobA, and JobB.

    The oids collection can also include JobGroup or JobQueue oids. In this case GetJobChain processes all jobs in the specified groups and queues.

    This method supports the Job Flow Diagram feature in the Console.

    See Also