Package zowe.client.sdk.zosjobs.methods

Class JobDelete

java.lang.Object

zowe.client.sdk.zosjobs.methods.JobDelete

public class JobDelete
extends Object

DeleteJobs class to handle Job delete

Version:

3.0

Author:

Nikunj Goyal

Constructor Summary

Constructors

Constructor	Description
JobDelete(ZosConnection connection)	DeleteJobs constructor
JobDelete(ZosConnection connection, ZosmfRequest request)	Alternative DeleteJobs constructor with ZoweRequest object.

Method Summary

Modifier and Type	Method	Description
Response	delete(String jobName, String jobId, String version)	Cancel and purge job from spool.
Response	deleteByJob(Job job, String version)	Cancel and purge a job from spool.
Response	deleteCommon(ModifyJobParams params)	Delete 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

JobDelete

public JobDelete(ZosConnection connection)

DeleteJobs constructor

Parameters:

connection - connection information, see ZosConnection object

JobDelete

public JobDelete(ZosConnection connection,
                 ZosmfRequest request)

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 object

Method Detail

delete

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

Cancel and purge job from spool.

Parameters:

jobName - name of job to delete

jobId - job id

version - version number, see ModifyJobParams object for version options

Returns:

http response object

Throws:

ZosmfRequestException - request error state

deleteCommon

public Response deleteCommon(ModifyJobParams params)
                      throws ZosmfRequestException

Delete a job on z/OS.

Parameters:

params - delete job parameters, see DeleteJobParams object

Returns:

http response object

Throws:

ZosmfRequestException - request error state

deleteByJob

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

Cancel and purge a job from spool.

Parameters:

job - job document wanting to delete

version - version number, see ModifyJobParams object for version options

Returns:

http response object

Throws:

ZosmfRequestException - request error state