com.ibm.optim.oaas.client.job.JobCallback.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api_java_client Show documentation

Java client API for DOCplexCloud, version 1.0-STABLE-b832

The newest version!







JobCallback (Java Client for DOcplexcloud 1.0 API)










Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.ibm.optim.oaas.client.job
Interface JobCallback






All Known Implementing Classes:
AbstractJobCallback




public interface JobCallback
Provides notifications when a job is executed and monitored by an executor.
See Also:
JobExecutor











Method Summary

Methods 

Modifier and Type
Method and Description


void
completed(JobResponse response)
Called when the executor has completed the processing of the job request.



void
created(JobResponse response)
Called when a job has been created.



void
exception(JobResponse response,
         Exception e)
Called when an exception has occurred.



void
failed(JobResponse response)
Called when a job has failed.



void
interruption(JobResponse response)
Called when a job is being interrupted or has already been interrupted.



void
processed(JobResponse response)
Called when a job has been processed.



void
running(JobResponse response)
Called when a job has started to run.



void
submitted(JobResponse response)
Called when a job has been submitted.
















Method Detail





created
void created(JobResponse response)
Called when a job has been created.
Parameters:
response - The job response providing data about the executing job.
See Also:
JobExecutionStatus.CREATED







submitted
void submitted(JobResponse response)
Called when a job has been submitted.
Parameters:
response - The job response providing data about the executing job.
See Also:
JobExecutionStatus.NOT_STARTED







running
void running(JobResponse response)
Called when a job has started to run. Note that this call can be skipped if
 the job execution is very short.
Parameters:
response - The job response providing data about the executing job.
See Also:
JobExecutionStatus.RUNNING







processed
void processed(JobResponse response)
Called when a job has been processed.
Parameters:
response - The job response providing data about the executing job.
See Also:
JobExecutionStatus.PROCESSED







failed
void failed(JobResponse response)
Called when a job has failed.
Parameters:
response - The job response providing data about the executing job.
See Also:
JobExecutionStatus.FAILED







interruption
void interruption(JobResponse response)
Called when a job is being interrupted or has already been interrupted.
Parameters:
response - The job response providing data about the executing job.
See Also:
JobExecutionStatus.INTERRUPTING, 
JobExecutionStatus.INTERRUPTED







exception
void exception(JobResponse response,
             Exception e)
Called when an exception has occurred.
Parameters:
response - The job response providing data about the executing job.
e - The raised exception.







completed
void completed(JobResponse response)
Called when the executor has completed the processing of the job request.
Parameters:
response - The job response providing data about the executing job.













Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2015–2017 IBM Corporation. Licensed under the Apache License, Version 2.0.

Modifier and Type	Method and Description
`void`	`completed(JobResponse response)` Called when the executor has completed the processing of the job request.
`void`	`created(JobResponse response)` Called when a job has been created.
`void`	`exception(JobResponse response, Exception e)` Called when an exception has occurred.
`void`	`failed(JobResponse response)` Called when a job has failed.
`void`	`interruption(JobResponse response)` Called when a job is being interrupted or has already been interrupted.
`void`	`processed(JobResponse response)` Called when a job has been processed.
`void`	`running(JobResponse response)` Called when a job has started to run.
`void`	`submitted(JobResponse response)` Called when a job has been submitted.