com.esri.arcgis.geoprocessing
Class GPServerTrackCancel

java.lang.Object
  com.esri.arcgis.geoprocessing.GPServerTrackCancel

All Implemented Interfaces:

IGPMessagesCallback, IGPServerTrackCancel, IGPServerTrackCancel2, com.esri.arcgis.interop.RemoteObjRef, IProgressor, IStepProgressor, ITrackCancel, java.io.Serializable

public class GPServerTrackCancel
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITrackCancel, IProgressor, IStepProgressor, IGPMessagesCallback, IGPServerTrackCancel, IGPServerTrackCancel2

COM Class 'GPServerTrackCancel'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriGeoprocessing.olb'

Description 'GP Server Track Cancel Class.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.system.ITrackCancel

IID, IID34c20005_4d3c_11d0_92d8_00805f7c28b0, xxDummy

Fields inherited from interface com.esri.arcgis.system.IStepProgressor

IID, IIDccdad2c7_8ebc_11d1_8732_0000f8751720, xxDummy

Fields inherited from interface com.esri.arcgis.system.IProgressor

IID3141f2f1_38e2_11d1_8809_080009ec732a

Fields inherited from interface com.esri.arcgis.geodatabase.IGPMessagesCallback

IID, IID1264c9a8_0afe_4903_87ba_a39b1f72779d, xxDummy

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPServerTrackCancel2

IID, IID979f4c54_02ae_4e8d_a808_62a428e95789, xxDummy

Fields inherited from interface com.esri.arcgis.geoprocessing.IGPServerTrackCancel

IIDe4212b92_2537_4489_83a9_a53ede41ca8e

Constructor Summary

GPServerTrackCancel()
Constructs a GPServerTrackCancel using ArcGIS Engine.

GPServerTrackCancel(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPServerTrackCancel theGPServerTrackCancel = (GPServerTrackCancel) obj;

Method Summary

void	cancel() Cancels the associated operation.
boolean	equals(java.lang.Object o) Compare this object with another
boolean	esri_continue() Called frequently while associated operation is progressing.
int	getCheckTime() The interval at which the operation will be interrupted to advance progressors and process messages.
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
IJobMessages	getJobMessages() The job messages.
int	getMaxRange() The maximum range of the progression.
java.lang.String	getMessage() The message displayed by the progressor.
int	getMessageLevel() The message level.
int	getMinRange() The minimum range of the progression.
int	getPosition() The current position of the progression.
IProgressor	getProgressor() The progressor used to show progress during lengthy operations.
int	getStepValue() The step increment of the progression.
int	hashCode() the hashcode for this object
void	hide() Hides the progressor.
void	init(java.lang.Object pJobTracker) Initialize the track cancel.
boolean	isCancelOnClick() Indicates whether mouse clicks should cancel the operation.
boolean	isCancelOnKeyPress() Indicates whether the escape key and spacebar should cancel the operation.
boolean	isProcessMessages() An obsolete method.
boolean	isTimerFired() An obsolete method.
void	messageAdded(IGPMessage message) Fired when a geoprocessing message is added.
int	offsetPosition(int offsetValue) Offsets the position of the progression.
void	release() Release a GPServerTrackCancel.
void	reset() Resets the manager after the associated operation is finished.
void	setCancelOnClick(boolean pCancelOnClick) Indicates whether mouse clicks should cancel the operation.
void	setCancelOnKeyPress(boolean pCancelOnKeyPress) Indicates whether the escape key and spacebar should cancel the operation.
void	setCheckTime(int milliseconds) The interval at which the operation will be interrupted to advance progressors and process messages.
void	setMaxRange(int maxRange) The maximum range of the progression.
void	setMessage(java.lang.String message) The message displayed by the progressor.
void	setMessageLevel(int messageLevel) The message level.
void	setMinRange(int minRange) The minimum range of the progression.
void	setPosition(int position) The current position of the progression.
void	setProcessMessages(boolean processMessages) An obsolete method.
void	setProgressor(IProgressor progressor) The progressor used to show progress during lengthy operations.
void	setStepValue(int step) The step increment of the progression.
void	show() Shows the progressor.
void	startTimer(int hWnd, int milliseconds) An obsolete method.
void	step() Animates or steps the progressor.
void	stopTimer() An obsolete method.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPServerTrackCancel

public GPServerTrackCancel()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a GPServerTrackCancel using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GPServerTrackCancel

public GPServerTrackCancel(java.lang.Object obj)
                    throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPServerTrackCancel theGPServerTrackCancel = (GPServerTrackCancel) obj;

Construct a GPServerTrackCancel using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to GPServerTrackCancel.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a GPServerTrackCancel.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setCheckTime

public void setCheckTime(int milliseconds)
                  throws java.io.IOException,
                         AutomationException

The interval at which the operation will be interrupted to advance progressors and process messages.

Specified by:

setCheckTime in interface ITrackCancel

Parameters:

milliseconds - The milliseconds (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCheckTime

public int getCheckTime()
                 throws java.io.IOException,
                        AutomationException

The interval at which the operation will be interrupted to advance progressors and process messages.

Specified by:

getCheckTime in interface ITrackCancel

Returns:

The milliseconds

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProgressor

public void setProgressor(IProgressor progressor)
                   throws java.io.IOException,
                          AutomationException

The progressor used to show progress during lengthy operations.

Specified by:

setProgressor in interface ITrackCancel

Parameters:

progressor - A reference to a com.esri.arcgis.system.IProgressor (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getProgressor

public IProgressor getProgressor()
                          throws java.io.IOException,
                                 AutomationException

The progressor used to show progress during lengthy operations.

Specified by:

getProgressor in interface ITrackCancel

Returns:

A reference to a com.esri.arcgis.system.IProgressor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

cancel

public void cancel()
            throws java.io.IOException,
                   AutomationException

Cancels the associated operation.

Specified by:

cancel in interface ITrackCancel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

public void reset()
           throws java.io.IOException,
                  AutomationException

Resets the manager after the associated operation is finished.

Specified by:

reset in interface ITrackCancel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_continue

public boolean esri_continue()
                      throws java.io.IOException,
                             AutomationException

Called frequently while associated operation is progressing. A return value of false indicates that the operation should stop.

Specified by:

esri_continue in interface ITrackCancel

Returns:

The keepGoing

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setProcessMessages

public void setProcessMessages(boolean processMessages)
                        throws java.io.IOException,
                               AutomationException

An obsolete method.

Specified by:

setProcessMessages in interface ITrackCancel

Parameters:

processMessages - The processMessages (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isProcessMessages

public boolean isProcessMessages()
                          throws java.io.IOException,
                                 AutomationException

An obsolete method.

Specified by:

isProcessMessages in interface ITrackCancel

Returns:

The processMessages

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

startTimer

public void startTimer(int hWnd,
                       int milliseconds)
                throws java.io.IOException,
                       AutomationException

An obsolete method.

Specified by:

startTimer in interface ITrackCancel

Parameters:

hWnd - The hWnd (in)

milliseconds - The milliseconds (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTimerFired

public boolean isTimerFired()
                     throws java.io.IOException,
                            AutomationException

An obsolete method.

Specified by:

isTimerFired in interface ITrackCancel

Returns:

The timerFired

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

stopTimer

public void stopTimer()
               throws java.io.IOException,
                      AutomationException

An obsolete method.

Specified by:

stopTimer in interface ITrackCancel

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelOnClick

public boolean isCancelOnClick()
                        throws java.io.IOException,
                               AutomationException

Indicates whether mouse clicks should cancel the operation.

Specified by:

isCancelOnClick in interface ITrackCancel

Returns:

The pCancelOnClick

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnClick

public void setCancelOnClick(boolean pCancelOnClick)
                      throws java.io.IOException,
                             AutomationException

Indicates whether mouse clicks should cancel the operation.

Specified by:

setCancelOnClick in interface ITrackCancel

Parameters:

pCancelOnClick - The pCancelOnClick (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isCancelOnKeyPress

public boolean isCancelOnKeyPress()
                           throws java.io.IOException,
                                  AutomationException

Indicates whether the escape key and spacebar should cancel the operation.

Specified by:

isCancelOnKeyPress in interface ITrackCancel

Returns:

The pCancelOnKeyPress

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCancelOnKeyPress

public void setCancelOnKeyPress(boolean pCancelOnKeyPress)
                         throws java.io.IOException,
                                AutomationException

Indicates whether the escape key and spacebar should cancel the operation.

Specified by:

setCancelOnKeyPress in interface ITrackCancel

Parameters:

pCancelOnKeyPress - The pCancelOnKeyPress (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessage

public void setMessage(java.lang.String message)
                throws java.io.IOException,
                       AutomationException

The message displayed by the progressor.

Specified by:

setMessage in interface IProgressor

Parameters:

message - The message (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessage

public java.lang.String getMessage()
                            throws java.io.IOException,
                                   AutomationException

The message displayed by the progressor.

Specified by:

getMessage in interface IProgressor

Returns:

The message

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

show

public void show()
          throws java.io.IOException,
                 AutomationException

Shows the progressor.

Specified by:

show in interface IProgressor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

step

public void step()
          throws java.io.IOException,
                 AutomationException

Animates or steps the progressor.

Specified by:

step in interface IProgressor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hide

public void hide()
          throws java.io.IOException,
                 AutomationException

Hides the progressor.

Specified by:

hide in interface IProgressor

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMinRange

public void setMinRange(int minRange)
                 throws java.io.IOException,
                        AutomationException

The minimum range of the progression.

Specified by:

setMinRange in interface IStepProgressor

Parameters:

minRange - The minRange (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMinRange

public int getMinRange()
                throws java.io.IOException,
                       AutomationException

The minimum range of the progression.

Specified by:

getMinRange in interface IStepProgressor

Returns:

The minRange

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaxRange

public void setMaxRange(int maxRange)
                 throws java.io.IOException,
                        AutomationException

The maximum range of the progression.

Specified by:

setMaxRange in interface IStepProgressor

Parameters:

maxRange - The maxRange (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaxRange

public int getMaxRange()
                throws java.io.IOException,
                       AutomationException

The maximum range of the progression.

Specified by:

getMaxRange in interface IStepProgressor

Returns:

The maxRange

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStepValue

public void setStepValue(int step)
                  throws java.io.IOException,
                         AutomationException

The step increment of the progression.

Specified by:

setStepValue in interface IStepProgressor

Parameters:

step - The step (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStepValue

public int getStepValue()
                 throws java.io.IOException,
                        AutomationException

The step increment of the progression.

Specified by:

getStepValue in interface IStepProgressor

Returns:

The step

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

public void setPosition(int position)
                 throws java.io.IOException,
                        AutomationException

The current position of the progression.

Specified by:

setPosition in interface IStepProgressor

Parameters:

position - The position (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPosition

public int getPosition()
                throws java.io.IOException,
                       AutomationException

The current position of the progression.

Specified by:

getPosition in interface IStepProgressor

Returns:

The position

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

offsetPosition

public int offsetPosition(int offsetValue)
                   throws java.io.IOException,
                          AutomationException

Offsets the position of the progression.

Specified by:

offsetPosition in interface IStepProgressor

Parameters:

offsetValue - The offsetValue (in)

Returns:

The prevPos

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

messageAdded

public void messageAdded(IGPMessage message)
                  throws java.io.IOException,
                         AutomationException

Fired when a geoprocessing message is added.

Specified by:

messageAdded in interface IGPMessagesCallback

Parameters:

message - A reference to a com.esri.arcgis.geodatabase.IGPMessage (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

init

public void init(java.lang.Object pJobTracker)
          throws java.io.IOException,
                 AutomationException

Initialize the track cancel.

Specified by:

init in interface IGPServerTrackCancel

Parameters:

pJobTracker - A reference to another Object (IUnknown) (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getJobMessages

public IJobMessages getJobMessages()
                            throws java.io.IOException,
                                   AutomationException

The job messages.

Specified by:

getJobMessages in interface IGPServerTrackCancel

Returns:

A reference to a com.esri.arcgis.system.IJobMessages

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMessageLevel

public int getMessageLevel()
                    throws java.io.IOException,
                           AutomationException

The message level.

Specified by:

getMessageLevel in interface IGPServerTrackCancel2

Returns:

A com.esri.arcgis.system.esriJobMessageType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMessageLevel

public void setMessageLevel(int messageLevel)
                     throws java.io.IOException,
                            AutomationException

The message level.

Specified by:

setMessageLevel in interface IGPServerTrackCancel2

Parameters:

messageLevel - A com.esri.arcgis.system.esriJobMessageType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.