Package zowe.client.sdk.zosjobs.methods

Class JobCancel

java.lang.Object

zowe.client.sdk.zosjobs.methods.JobCancel

public class JobCancel
extends Object

CancelJobs class to handle Job cancel on z/OS

Version:

4.0

Author:

Nikunj Goyal, Frank Giordano

Constructor Summary

Constructors

Constructor	Description
JobCancel(ZosConnection connection)	CancelJobs constructor

Method Summary

Modifier and Type	Method	Description
Response	cancel(String jobName, String jobId, String version)	Cancel a job on z/OS by job name and job id values.
Response	cancelByJob(Job job, String version)	Cancel a job on z/OS by job object.
Response	cancelCommon(ModifyJobParams params)	Cancel a job on z/OS by ModifyJobParams object.
Response	cancelPurge(String jobName, String jobId, String version)	Cancel a job on z/OS by job name and job id values and purge the job output.
Response	cancelPurgeByJob(Job job, String version)	Cancel a job on z/OS by job object and purge the job output.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JobCancel

public JobCancel(ZosConnection connection)

CancelJobs constructor

Parameters:

connection - for connection information, see ZosConnection object

Method Detail

cancel

public Response cancel(String jobName,
                       String jobId,
                       String version)
                throws ZosmfRequestException

Cancel a job on z/OS by job name and job id values.

Parameters:

jobName - name of a job to cancel

jobId - job id

version - version number - 1.0 or 2.0 To request asynchronous processing for this service (the default), set the "version" property to 1.0 or omit the property from the request. To request synchronous processing, set "version" to 2.0. If so, the system will attempt to process the request synchronously if such processing is supported on the target JES2 subsystem.

Returns:

job document with details about the submitted job

Throws:

ZosmfRequestException - request error state

cancelByJob

public Response cancelByJob(Job job,
                            String version)
                     throws ZosmfRequestException

Cancel a job on z/OS by job object.

Parameters:

job - job document wanting to cancel

version - version number - 1.0 or 2.0 To request asynchronous processing for this service (the default), set the "version" property to 1.0 or omit the property from the request. To request synchronous processing, set "version" to 2.0. If so, the system will attempt to process the request synchronously if such processing is supported on the target JES2 subsystem.

Returns:

job document with details about the submitted job

Throws:

ZosmfRequestException - request error state

cancelPurge

public Response cancelPurge(String jobName,
                            String jobId,
                            String version)
                     throws ZosmfRequestException

Cancel a job on z/OS by job name and job id values and purge the job output.

Parameters:

jobName - name of a job to cancel

jobId - job id

version - version number - 1.0 or 2.0 To request asynchronous processing for this service (the default), set the "version" property to 1.0 or omit the property from the request. To request synchronous processing, set "version" to 2.0. If so, the system will attempt to process the request synchronously if such processing is supported on the target JES2 subsystem.

Returns:

job document with details about the submitted job

Throws:

ZosmfRequestException - request error state

cancelPurgeByJob

public Response cancelPurgeByJob(Job job,
                                 String version)
                          throws ZosmfRequestException

Cancel a job on z/OS by job object and purge the job output.

Parameters:

job - job document wanting to cancel

version - version number - 1.0 or 2.0 To request asynchronous processing for this service (the default), set the "version" property to 1.0 or omit the property from the request. To request synchronous processing, set "version" to 2.0. If so, the system will attempt to process the request synchronously if such processing is supported on the target JES2 subsystem.

Returns:

job document with details about the submitted job

Throws:

ZosmfRequestException - request error state

cancelCommon

public Response cancelCommon(ModifyJobParams params)
                      throws ZosmfRequestException

Cancel a job on z/OS by ModifyJobParams object.

Parameters:

params - cancel job parameters, see cancelJobsCommon object

Returns:

job document with details about the submitted job

Throws:

ZosmfRequestException - request error state