CancelJob

From TurnKey+MediaWiki
Jump to navigationJump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Method

CancelJobResult cancelJob(UserIDBean userID, JobTemporalIDBean jobID, String reason)

Description

Attempts to cancel a job.

Parameters

Type Name Description
UserIDBean userID The admin username and password.
JobTemporalIDBean jobID The primary key of the job, and the update index, to confirm the external systems details are up to date.
String reason The reason for cancelling the job, must match the list defined when the organisation was setup.

Return Value

CancelJobResult