com.esri.arcgis.geoprocessing
Interface IGPToolBackground

All Superinterfaces:

Serializable

public interface IGPToolBackground
extends Serializable

Tool Background Implementation Interface.

Description

This interface allows to force a custom geoprocessing tool ro run in the foreground only. If the application which is executing the tool (ArcMap, for example) has the background processing setting enabled, it can be overridden by setting CanRunInBackground property to true.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

boolean	isCanRunInBackground() Can this tool run in the background.
void	setCanRunInBackground(boolean pCanRunInBackground) Can this tool run in the background.

Method Detail

isCanRunInBackground

boolean isCanRunInBackground()
                             throws IOException,
                                    AutomationException

Can this tool run in the background.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The pCanRunInBackground

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCanRunInBackground

void setCanRunInBackground(boolean pCanRunInBackground)
                           throws IOException,
                                  AutomationException

Can this tool run in the background.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

pCanRunInBackground - The pCanRunInBackground (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.