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
JobCancel(ZosConnection connection, ZosmfRequest request)	Alternative CancelJobs constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
Response	cancel(String jobName, String jobId, String version)	Cancel a job on z/OS.
Response	cancelByJob(Job job, String version)	Cancel a job on z/OS.
Response	cancelCommon(ModifyJobParams params)	Cancel a job on z/OS.

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

JobCancel

public JobCancel(ZosConnection connection,
                 ZosmfRequest request)

Alternative CancelJobs constructor with ZoweRequest object. This is mainly used for internal code unit testing with mockito, and it is not recommended to be used by the larger community.

Parameters:

connection - for connection information, see ZosConnection object

request - any compatible ZoweRequest Interface object

Method Detail

cancel

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

Cancel a job on z/OS.

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.

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.

Parameters:

params - cancel job parameters, see cancelJobsCommon object

Returns:

job document with details about the submitted job

Throws:

ZosmfRequestException - request error state