java.lang.Object
- com.avoka.tm.job.Jobs

public class Jobs
extends java.lang.Object

Provides Job utility functions.

Examples

Get Start Transaction

Return the start (first) transaction for the job.

 import com.avoka.tm.job.*
 import com.avoka.tm.vo.*

 Txn txn = Jobs.getStartTxn(job)

Get Start Transaction XML Data

Return the XML of the start transaction for the job.

 import com.avoka.tm.job.*
 import com.avoka.tm.util.*
 import com.avoka.tm.vo.*

 String xml = Jobs.getStartTxnXml(job)

 Path path = new Path(xml)

Get Start User

Return the User of the starting transaction for the job.

 import com.avoka.tm.job.*
 import com.avoka.tm.vo.*

 User user = Jobs.getStartUser(job)

Since:: 5.0.0

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method	Description
`static Txn`	`getStartTxn(Job job)`	Return the start transaction for the given job.
`static java.lang.String`	`getStartTxnXml(Job job)`	Return the start transaction XML for the given job.
`static User`	`getStartUser(Job job)`	Return the start user for the given job.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getStartTxn
```
public static Txn getStartTxn(Job job)
```
    Return the start transaction for the given job. The returned transaction include formDataMap, groupNames and propertyMap.
    Example
    
    import com.avoka.tm.job.* import com.avoka.tm.vo.* Txn txn = Jobs.getStartTxn(job)
    Parameters:
    
    job - the job to query (required)
    
    Returns:
    
    the start transaction, or null if not found
  - getStartTxnXml
```
public static java.lang.String getStartTxnXml(Job job)
```
    Return the start transaction XML for the given job.
    Example
    
    import com.avoka.tm.job.* import com.avoka.tm.util.* import com.avoka.tm.vo.* String xml = Jobs.getStartTxnXml(job) Path path = new Path(xml)
    Parameters:
    
    job - the job to query (required)
    
    Returns:
    
    the start transaction XML, or null if not found
  - getStartUser
```
public static User getStartUser(Job job)
```
    Return the start user for the given job.
    Example
    
    import com.avoka.tm.job.* import com.avoka.tm.vo.* User user = Jobs.getStartUser(job)
    Parameters:
    
    job - the job to query (required)
    
    Returns:
    
    the start user, or null if not found