com.esri.adf.web.ags.data.gp
Class AGSGPFunctionality

java.lang.Object
  com.esri.adf.web.ags.data.gp.AGSGPFunctionality

All Implemented Interfaces:

GISFunctionality, Serializable

public class AGSGPFunctionality
extends Object
implements GISFunctionality, Serializable

See Also:

Serialized Form

Constructor Summary

AGSGPFunctionality()

Method Summary

void	destroyFunctionality() The cleanup chores (such as releasing held resources) for the functionality must be performed in this method.
com.esri.arcgisws.GPResult	executeTask()
com.esri.arcgisws.GPResult	executeTask(GPParam[] inParams, GPParam[] outParams)
GPTaskConfig	getConfig()
com.esri.arcgisws.GPToolInfo	getGPTask()
GPParam[]	getInputParams()
com.esri.arcgisws.JobMessage[]	getJobMessages(String jobID)
int	getLastFeatureIdAssigned()
GPParam[]	getOutputParams()
AGSGPResource	getResource() Returns the GISResource associated with this functionality.
Object	getTaskContent(String contentId)
com.esri.adf.web.ags.data.gp.GPTaskInfo	getTaskInfo()
String	getTaskName()
com.esri.arcgisws.EsriJobStatus	getTaskStatus(String jobID, GPParam[] inParams, GPParam[] outParams)
void	initFunctionality(GISResource res) The initialization chores for the functionality must be performed in this method.
void	initGPTask(com.esri.arcgisws.GPToolInfo useAsInput)
boolean	isAsyncExecution()
boolean	isDrawResultsOnServer()
boolean	isShowMessages()
void	runTask(TaskEvent event)
void	setAsyncExecution(boolean asyncExecution)
void	setConfig(GPTaskConfig config)
void	setDrawResultsOnServer(boolean drawResultsOnServer)
void	setLastFeatureIdAssigned(int nextFeatureId)
void	setShowMessages(boolean showMessages)
void	setTaskContent(String contentId, Object content)
void	setTaskName(String taskName)
String	submitTask()
String	submitTask(GPParam[] inParams, GPParam[] outParams)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AGSGPFunctionality

public AGSGPFunctionality()

Method Detail

initFunctionality

public void initFunctionality(GISResource res)

Description copied from interface: GISFunctionality

The initialization chores for the functionality must be performed in this method. This method is called by the resource when the functionality needs to be initialized. This happens either when the resource itself is being initialized or if users add this functionality to the resource using the GISResource.addFunctionality(String, GISFunctionality) method after the resource has already been initialized.

Classes which implement this method should maintain the resource as a class instance variable and return the same in the GISFunctionality.getResource() method. The functionality is ready for use only after this method has been called.

Specified by:

initFunctionality in interface GISFunctionality

Parameters:

res - the GISResource that this functionality supports

See Also:

GISResource.init(WebContext)

destroyFunctionality

public void destroyFunctionality()

Description copied from interface: GISFunctionality

The cleanup chores (such as releasing held resources) for the functionality must be performed in this method. This method is called by the GISResource when the resource itself is being destroyed.

The functionality is no longer usable after this method has been called.

Specified by:

destroyFunctionality in interface GISFunctionality

See Also:

GISResource.destroy()

getGPTask

public com.esri.arcgisws.GPToolInfo getGPTask()

initGPTask

public void initGPTask(com.esri.arcgisws.GPToolInfo useAsInput)

runTask

public void runTask(TaskEvent event)

executeTask

public com.esri.arcgisws.GPResult executeTask()

executeTask

public com.esri.arcgisws.GPResult executeTask(GPParam[] inParams,
                                              GPParam[] outParams)

submitTask

public String submitTask()

submitTask

public String submitTask(GPParam[] inParams,
                         GPParam[] outParams)

getTaskStatus

public com.esri.arcgisws.EsriJobStatus getTaskStatus(String jobID,
                                                     GPParam[] inParams,
                                                     GPParam[] outParams)

getJobMessages

public com.esri.arcgisws.JobMessage[] getJobMessages(String jobID)

getResource

public AGSGPResource getResource()

Description copied from interface: GISFunctionality

Returns the GISResource associated with this functionality.

The resource passed to GISFunctionality.initFunctionality(GISResource) is maintained as a class variable and is accessible through this method.

Specified by:

getResource in interface GISFunctionality

Returns:

the GISResource associated with this functionality

getTaskName

public String getTaskName()

setTaskName

public void setTaskName(String taskName)

getInputParams

public GPParam[] getInputParams()

getOutputParams

public GPParam[] getOutputParams()

setAsyncExecution

public void setAsyncExecution(boolean asyncExecution)

isAsyncExecution

public boolean isAsyncExecution()

isShowMessages

public boolean isShowMessages()

setShowMessages

public void setShowMessages(boolean showMessages)

getConfig

public GPTaskConfig getConfig()

setConfig

public void setConfig(GPTaskConfig config)

isDrawResultsOnServer

public boolean isDrawResultsOnServer()

setDrawResultsOnServer

public void setDrawResultsOnServer(boolean drawResultsOnServer)

setTaskContent

public void setTaskContent(String contentId,
                           Object content)

getTaskContent

public Object getTaskContent(String contentId)

setLastFeatureIdAssigned

public void setLastFeatureIdAssigned(int nextFeatureId)

Parameters:

nextFeatureId - the nextFeatureId to set

getLastFeatureIdAssigned

public int getLastFeatureIdAssigned()

Returns:

the nextFeatureId

toString

public String toString()

Overrides:

toString in class Object

getTaskInfo

public com.esri.adf.web.ags.data.gp.GPTaskInfo getTaskInfo()