Package com.intellij.openapi.externalSystem.service.internal

Interface ExternalSystemTaskAware

All Known Subinterfaces:

RemoteExternalSystemFacade<S>, RemoteExternalSystemProjectResolver<S>, RemoteExternalSystemService<S>, RemoteExternalSystemTaskManager<S>

All Known Implementing Classes:

AbstractExternalSystemFacadeImpl, AbstractRemoteExternalSystemService, AbstractRemoteExternalSystemServiceWrapper, ExternalSystemFacadeWrapper, ExternalSystemProjectResolverWrapper, ExternalSystemTaskManagerWrapper, InProcessExternalSystemFacadeImpl, RemoteExternalSystemFacadeImpl, RemoteExternalSystemProjectResolverImpl, RemoteExternalSystemTaskManagerImpl

public interface ExternalSystemTaskAware

Represents a service that exposes information about the tasks being processed.

Method Summary

Modifier and Type	Method and Description
boolean	cancelTask(ExternalSystemTaskId id) Allows to cancel the target task by the current service.
java.util.Map<ExternalSystemTaskType,java.util.Set<ExternalSystemTaskId>>	getTasksInProgress() Allows to ask current service for all tasks being executed at the moment.
boolean	isTaskInProgress(ExternalSystemTaskId id) Allows to check if current service executes the target task.

Method Detail

isTaskInProgress

boolean isTaskInProgress(ExternalSystemTaskId id)
                  throws java.rmi.RemoteException

Allows to check if current service executes the target task.

Parameters:

id - target task's id

Returns:

true if a task with the given id is executed at the moment by the current service; false otherwise

Throws:

java.rmi.RemoteException - as required by RMI

cancelTask

boolean cancelTask(ExternalSystemTaskId id)
            throws java.rmi.RemoteException

Allows to cancel the target task by the current service.

Parameters:

id - target task's id

Returns:

true if a task was successfully canceled; false otherwise

Throws:

java.rmi.RemoteException - as required by RMI

getTasksInProgress

java.util.Map<ExternalSystemTaskType,java.util.Set<ExternalSystemTaskId>> getTasksInProgress()
                                                                                      throws java.rmi.RemoteException

Allows to ask current service for all tasks being executed at the moment.

Returns:

ids of all tasks being executed at the moment grouped by type

Throws:

java.rmi.RemoteException - as required by RMI