public interface IJob

A job in the Job Entry Subsystem (JES).

The state of this job is a snapshot from the time it was retrieved from the host. In order to retrieve the current state of this job, it will need to be re-retrieved from the host.

Examples:
To retrieve a list of jobs matching a job name filter and/or an owner filter:

 IJESCommandProvider commandProvider = ...
 String jobNameFilter = ...
 String ownerFilter = ...
 
 // jobs will be empty if no jobs match the filters
 List<IJob> jobs = commandProvider.findJobs(jobNameFilter, ownerFilter);

To retrieve a list of jobs matching a job name filter and/or an owner filter with a JES limit:

 IJESCommandProvider commandProvider = ...
 String jobNameFilter = ...
 String ownerFilter = ...
 int jesLimit = ...
 
 // jobs will be empty if no jobs match the filters
 // the number of returned jobs will be limited by jesLimit
 List<IJob> jobs = commandProvider.findJobs(jobNameFilter, ownerFilter,
         jesLimit);

To retrieve a list of jobs matching a job name filter and/or an owner filter on a specific JES queue:

 IJESCommandProvider commandProvider = ...
 String jobNameFilter = ...
 String ownerFilter = ...
 int jesLimit = ...
 boolean includePrintQueue = ...
 boolean includeExecutionQueue = ...
 
 // jobs will be empty if no jobs match the filters and JES queue
 // the number of returned jobs will be limited by jesLimit
 List<IJob> jobs = commandProvider.findJobs(jobNameFilter, ownerFilter,
         jesLimit, includePrintQueue, includeExecutionQueue);

For examples on how to obtain an IJESCommandProvider see IJESCommandProvider.
For examples on how to retrieve a job's ISysoutDataDefinitions see ISysoutDataDefinition.

Since:: 2.2.0
Version:: 2.2.0
See Also:: IJESCommandProvider, ISysoutDataDefinition
Restriction:: This interface is not intended to be extended by clients.
Restriction:: This interface is not intended to be implemented by clients.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`List<ISysoutDataDefinition>`	`fetchSysoutDataDefinitions()`	Retrieves the current list of sysout data definitions (DDs) for this job.
`String`	`getActiveSystem()`	Returns the active system name for this job
`String`	`getAsidx()`	Retrieves the ASID of the job.
`Date`	`getEndDate()`	Returns the date on which this job stopped executing.
`ExecutionStatus`	`getExecutionStatus()`	Returns the execution status of this job.
`String`	`getID()`	Returns the ID of this job.
`IZOSHostConnection`	`getIZOSHostConnection()`	Returns the IZOSHostConnection associated with this job
`JESQueue`	`getJESQueue()`	Returns the JES queue of this job.
`String`	`getJobClass()`	Returns the job class of this job.
`JobInfo`	`getJobInfo()`	Returns a job information object that uniquely identifies this job.
`String`	`getName()`	Returns the name of this job.
`String`	`getOwner()`	Returns the owner of this job.
`String`	`getProgrammerName()`	Returns the programmer name of this job, as specified in the job card.
`int`	`getQueuePosition()`	Returns the position of this job in the JES queue.
`String`	`getReturnCode()`	Returns the return code of this job.
`Date`	`getStartDate()`	Returns the date on which this job started executing.
`Date`	`getSubmitDate()`	Returns the date on which this job was submitted.
`String`	`getSystemName()`	Returns the name of the system this job executed or is executing on.
`boolean`	`isBlockedByDuplicate()`	Returns the this job is blocked from execution by another job, executing with the same name.
`boolean`	`isHeld()`	Returns the this job is being held.

- Method Detail
  - getJobInfo
```
JobInfo getJobInfo()
```
    Returns a job information object that uniquely identifies this job.
    This JobInfo object can be used in other methods as a "handle" to this job.
    
    Returns:
    
    the job info
    
    Since:
    
    2.2.0
  - getName
```
String getName()
```
    Returns the name of this job.
    
    Returns:
    
    the job name
    
    Since:
    
    2.2.0
  - getID
```
String getID()
```
    Returns the ID of this job.
    
    Returns:
    
    the job ID
    
    Since:
    
    2.2.0
  - getOwner
```
String getOwner()
```
    Returns the owner of this job.
    
    Returns:
    
    the owner
    
    Since:
    
    2.2.0
  - getReturnCode
```
String getReturnCode()
```
    Returns the return code of this job.
    
    Returns:
    
    the return code
    
    Since:
    
    2.2.0
  - getJobClass
```
String getJobClass()
```
    Returns the job class of this job.
    
    Returns:
    
    the job class
    
    Since:
    
    2.2.0
  - getJESQueue
```
JESQueue getJESQueue()
```
    Returns the JES queue of this job.
    
    Returns:
    
    the JES queue
    
    Since:
    
    2.2.0
  - getExecutionStatus
```
ExecutionStatus getExecutionStatus()
```
    Returns the execution status of this job.
    
    Returns:
    
    the execution status
    
    Since:
    
    2.2.0
    
    See Also:
    
    ExecutionStatus
  - isHeld
```
boolean isHeld()
```
    Returns the this job is being held.
    This method returns true both for jobs being held from execution and for jobs being held from output.
    
    Returns:
    
    true if this job is being held, otherwise false
    
    Since:
    
    2.2.0
  - isBlockedByDuplicate
```
boolean isBlockedByDuplicate()
```
    Returns the this job is blocked from execution by another job, executing with the same name.
    
    Returns:
    
    true if this job is blocked, otherwise false
    
    Since:
    
    2.2.0
  - getSystemName
```
String getSystemName()
```
    Returns the name of the system this job executed or is executing on.
    This method will return null if the job has not executed yet.
    
    Returns:
    
    the system name or null if the job has not executed yet.
    
    Since:
    
    2.2.0
  - getActiveSystem
```
String getActiveSystem()
```
    Returns the active system name for this job
    This method will return null if the job has not executed yet.
    
    Returns:
    
    the active system name or null
    
    Since:
    
    2.3.0
  - getQueuePosition
```
int getQueuePosition()
```
    Returns the position of this job in the JES queue.
    
    Returns:
    
    the queue position
    
    Since:
    
    2.2.0
  - getProgrammerName
```
String getProgrammerName()
```
    Returns the programmer name of this job, as specified in the job card.
    
    Returns:
    
    the programmer name
    
    Since:
    
    2.2.0
  - getSubmitDate
```
Date getSubmitDate()
```
    Returns the date on which this job was submitted.
    
    Returns:
    
    the submit date
    
    Since:
    
    2.2.0
  - getStartDate
```
Date getStartDate()
```
    Returns the date on which this job started executing.
    This method will return null if the job has not started yet.
    
    Returns:
    
    the start date, or null if the job has not started yet
    
    Since:
    
    2.2.0
  - getEndDate
```
Date getEndDate()
```
    Returns the date on which this job stopped executing.
    This method will return null if the job has not ended yet.
    
    Returns:
    
    the end date, or null if the job has not ended yet
    
    Since:
    
    2.2.0
  - getAsidx
```
String getAsidx()
```
    Retrieves the ASID of the job. This may be null.
    
    Returns:
    
    the String asid or null.
  - getIZOSHostConnection
```
IZOSHostConnection getIZOSHostConnection()
```
    Returns the IZOSHostConnection associated with this job
    
    Returns:
    
    the IZOSHostConnection
    
    Since:
    
    2.2.0
  - fetchSysoutDataDefinitions
```
List<ISysoutDataDefinition> fetchSysoutDataDefinitions()
```
    Retrieves the current list of sysout data definitions (DDs) for this job.
    
    Returns:
    
    the sysout data definitions
    
    Throws:
    
    ZOSSystemException - if a z/OS system error occurs
    
    ZOSAbendException - if a z/OS ABEND occurs
    
    Since:
    
    2.2.0

Interface IJob

Method Summary

Method Detail

getJobInfo

getName

getID

getOwner

getReturnCode

getJobClass

getJESQueue

getExecutionStatus

isHeld

isBlockedByDuplicate

getSystemName

getActiveSystem

getQueuePosition

getProgrammerName

getSubmitDate

getStartDate

getEndDate

getAsidx

getIZOSHostConnection

fetchSysoutDataDefinitions