Uses of Interface
org.cytoscape.jobs.CyJob

Packages that use CyJob

Package	Description
org.cytoscape.jobs	This package provides a mechanism for executing remote jobs from within Cytoscape.

Uses of CyJob in org.cytoscape.jobs

Classes in org.cytoscape.jobs that implement CyJob

Modifier and Type	Class	Description
class	AbstractCyJob	This can be used as a base class for custom implementations of CyJob

Methods in org.cytoscape.jobs that return CyJob

Modifier and Type	Method	Description
CyJob	CyJobExecutionService.createCyJob(String name)	Create an empty (unsubmitted) CyJob
CyJob	CyJobExecutionService.restoreJobFromSession(CySession session, File sessionFile)	This is method is called by the CyJobManager to restore the job and reestablish the job with the remote service.

Methods in org.cytoscape.jobs that return types with arguments of type CyJob

Modifier and Type	Method	Description
List<CyJob>	CyJobManager.getJobs()	Return the list of CyJobs currently managed by the CyJobManager.

Methods in org.cytoscape.jobs with parameters of type CyJob

Modifier and Type	Method	Description
void	CyJobManager.addJob(CyJob job, CyJobMonitor jobMonitor, int pollInterval)	Add a job to be managed by the job manager.
void	CyJobManager.associateMonitor(CyJob job, String jobMonitorName, int pollInterval)	Associate a handler with a job.
void	CyJobManager.associateMonitor(CyJob job, CyJobMonitor jobMonitor, int pollInterval)	Associate a monitor with a job.
CyJobStatus	CyJobExecutionService.cancelJob(CyJob job)	Cancel a running job.
CyJobStatus	CyJobManager.cancelJob(CyJob job)	Cancel the specified job
CyJobStatus	CyJobExecutionService.checkJobStatus(CyJob job)	Check on the status of a running job.
CyJobStatus	CyJobExecutionService.executeJob(CyJob job, String basePath, Map<String,Object> configuration, CyJobData inputData)	Submit a CyJob for remote execution.
CyJobStatus	CyJobExecutionService.fetchResults(CyJob job, CyJobData data)	After a CyJob status returns CyJobStatus.Status.FINISHED, this method is used to fetch the results from the job execution.
default void	CyJobMonitor.jobStatusChanged(CyJob job, CyJobStatus status)	This method is called whenever the status of a job changes.
void	CyJobMonitor.loadData(CyJob job, TaskMonitor taskMonitor)	This method is called when when the job status transitions to FINISHED and the user has indicated that they are ready to load the data from the task.
void	CyJobManager.removeJob(CyJob job)	Remove a job from being managed by the job manager.
static CyNetwork	SUIDUtil.restoreNetwork(CyJob job, CyNetworkManager netManager, Long networkSUID, boolean clear)	This method is used to restore a saved network based on the network SUID.
static Map<Long,CyIdentifiable>	SUIDUtil.restoreSUIDs(CyJob job, CyNetwork network, List<Long> oldIds, boolean clear)	Method to restore Cytoscape objects based on a list of SUIDs that were sent to the remote service as saved in the hidden table.
void	CyJobExecutionService.saveJobInSession(CyJob job, File sessionFile)	This is method is called by the CyJobManager to save sufficient information as part of the session to be able to restore and reestablish the job with the remote service.
static void	SUIDUtil.saveSUIDs(CyJob job, CyNetwork network, List<? extends CyIdentifiable> objs)	This method may be used to save a list of SUIDs that have been sent to a remote service so that they may be restored later