Package zowe.client.sdk.zosjobs

Class CancelJobs

java.lang.Object

zowe.client.sdk.zosjobs.CancelJobs

public class CancelJobs
extends Object

CancelJobs class to handle Job cancel

Version:

1.0

Author:

Nikunj Goyal

Constructor Summary

Constructors

Constructor	Description
CancelJobs(ZOSConnection connection)	CancelJobs constructor

Method Summary

Modifier and Type	Method	Description
Response	cancelJob(String jobName, String jobId, String version)	Cancel a job that resides in a z/OS data set.
Response	cancelJobForJob(Job job, String version)	Cancel a job that resides in a z/OS data set.
Response	cancelJobsCommon(ModifyJobParams params)	Cancel a job that resides in a z/OS data set.

Methods inherited from class java.lang.Object

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

Constructor Detail

CancelJobs

public CancelJobs(ZOSConnection connection)

CancelJobs constructor

Parameters:

connection - connection information, see ZOSConnection object

Method Detail

cancelJob

public Response cancelJob(String jobName,
                          String jobId,
                          String version)
                   throws Exception

Cancel a job that resides in a z/OS data set.

Parameters:

jobName - name of job to cancel

jobId - job id

version - version number

Returns:

job document with details about the submitted job

Throws:

Exception - error canceling

cancelJobForJob

public Response cancelJobForJob(Job job,
                                String version)
                         throws Exception

Cancel a job that resides in a z/OS data set.

Parameters:

job - job document wanting to cancel

version - version number

Returns:

job document with details about the submitted job

Throws:

Exception - error canceling

cancelJobsCommon

public Response cancelJobsCommon(ModifyJobParams params)
                          throws Exception

Cancel a job that resides in a z/OS data set.

Parameters:

params - cancel job parameters, see cancelJobsCommon object

Returns:

job document with details about the submitted job

Throws:

Exception - error canceling