Package zowe.client.sdk.zosjobs

Class DeleteJobs

java.lang.Object

zowe.client.sdk.zosjobs.DeleteJobs

public class DeleteJobs
extends Object

DeleteJobs class to handle Job delete

Version:

1.0

Author:

Nikunj Goyal

Constructor Summary

Constructors

Constructor	Description
DeleteJobs(ZOSConnection connection)	DeleteJobs constructor
DeleteJobs(ZOSConnection connection, ZoweRequest request)	Alternative DeleteJobs constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
Response	deleteJob(String jobName, String jobId, String version)	Cancel and purge job from spool.
Response	deleteJobCommon(ModifyJobParams params)	Delete a job that resides in a z/OS data set.
Response	deleteJobForJob(Job job, String version)	Cancel and purge job from spool.

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteJobs

public DeleteJobs(ZOSConnection connection)

DeleteJobs constructor

Parameters:

connection - connection information, see ZOSConnection object

DeleteJobs

public DeleteJobs(ZOSConnection connection,
                  ZoweRequest request)
           throws Exception

Alternative DeleteJobs 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 - connection information, see ZOSConnection object

request - any compatible ZoweRequest Interface type object

Throws:

Exception - processing error

Method Detail

deleteJob

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

Cancel and purge job from spool.

Parameters:

jobName - name of job to delete

jobId - job id

version - version number

Returns:

http response object

Throws:

Exception - error deleting

deleteJobForJob

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

Cancel and purge job from spool.

Parameters:

job - job document wanting to delete

version - version number

Returns:

http response object

Throws:

Exception - error deleting

deleteJobCommon

public Response deleteJobCommon(ModifyJobParams params)
                         throws Exception

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

Parameters:

params - delete job parameters, see DeleteJobParams object

Returns:

http response object

Throws:

Exception - error on deleting