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

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

All Implemented Interfaces:

GPParam, CompositeTaskParamDescriptorModel, TaskParamDescriptorModel, java.io.Serializable

public class GPRecordSetParam
extends java.lang.Object
implements GPParam, CompositeTaskParamDescriptorModel

See Also:

Serialized Form

Field Summary

static java.lang.String	GP_FEATURE_RECORD_SET_LAYER_DATA_TYPE
static java.lang.String	GP_RECORD_SET_DATA_TYPE
static java.lang.String	RENDERER_TYPE

Constructor Summary

GPRecordSetParam()

Method Summary

com.esri.arcgisws.Record	addRecord(MapEvent event)
com.esri.arcgisws.Record	addRecord(TaskEvent event)
void	afterTaskExecute(java.lang.String jobID)
void	beforeTaskExecute()
void	cancelAttributeEdits(TaskEvent event)
ResultNode	createResultNode(java.lang.String jobID)
java.lang.Object	decodeXML(java.lang.Object task, org.w3c.dom.Element element)
org.w3c.dom.Element	generateXML(java.lang.Object task) Generates the XML content for this parameter.
java.lang.String	getDisplayName() Returns the display text for the parameter.
com.esri.arcgisws.Field[]	getFields()
com.esri.arcgisws.GeometryDef	getGeometryDef()
com.esri.arcgisws.EsriGeometryType	getGeometryType()
java.lang.String	getGPDataType()
com.esri.arcgisws.GPParameterInfo	getGPParamInfo()
java.lang.String	getName() Returns the name of the parameter.
int	getOIDFieldIndex()
java.lang.Object	getParamValue(java.lang.Object task) Returns the current value of the parameter for the given task.
com.esri.arcgisws.RecordSet	getRecordSet()
java.lang.String	getRendererType() Returns the renderer type for the parameter.
int	getShapeFieldIndex()
void	initParam(AGSGPFunctionality gpFunc, com.esri.arcgisws.GPParameterInfo paramInfo)
void	removeRecords(TaskEvent event)
void	saveAttributeEdits(TaskEvent event)
java.lang.Object	setParamValue(java.lang.Object task, java.lang.String strVal) Sets the parameter value on the task and returns the set value.
void	setRecordSet(com.esri.arcgisws.RecordSet rs)
void	showAttributes(TaskEvent event)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GP_RECORD_SET_DATA_TYPE

public static final java.lang.String GP_RECORD_SET_DATA_TYPE

See Also:

Constant Field Values

GP_FEATURE_RECORD_SET_LAYER_DATA_TYPE

public static final java.lang.String GP_FEATURE_RECORD_SET_LAYER_DATA_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

See Also:

Constant Field Values

Constructor Detail

GPRecordSetParam

public GPRecordSetParam()

Method Detail

initParam

public void initParam(AGSGPFunctionality gpFunc,
                      com.esri.arcgisws.GPParameterInfo paramInfo)

Specified by:

initParam in interface GPParam

beforeTaskExecute

public void beforeTaskExecute()

Specified by:

beforeTaskExecute in interface GPParam

afterTaskExecute

public void afterTaskExecute(java.lang.String jobID)

Specified by:

afterTaskExecute in interface GPParam

getGPDataType

public java.lang.String getGPDataType()

Specified by:

getGPDataType in interface GPParam

addRecord

public com.esri.arcgisws.Record addRecord(TaskEvent event)

addRecord

public com.esri.arcgisws.Record addRecord(MapEvent event)

showAttributes

public void showAttributes(TaskEvent event)

cancelAttributeEdits

public void cancelAttributeEdits(TaskEvent event)

saveAttributeEdits

public void saveAttributeEdits(TaskEvent event)

removeRecords

public void removeRecords(TaskEvent event)

getRecordSet

public com.esri.arcgisws.RecordSet getRecordSet()

setRecordSet

public void setRecordSet(com.esri.arcgisws.RecordSet rs)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getGPParamInfo

public com.esri.arcgisws.GPParameterInfo getGPParamInfo()

Specified by:

getGPParamInfo in interface GPParam

setParamValue

public java.lang.Object setParamValue(java.lang.Object task,
                                      java.lang.String strVal)

Description copied from interface: TaskParamDescriptorModel

Sets the parameter value on the task and returns the set value. This method should convert the string input to the appropriate parameter type before setting the parameter.

Specified by:

setParamValue in interface TaskParamDescriptorModel

Parameters:

task - the task object on which to set the parameter value

strVal - the string representation of the parameter value to be set

Returns:

the set parameter value

getParamValue

public java.lang.Object getParamValue(java.lang.Object task)

Description copied from interface: TaskParamDescriptorModel

Returns the current value of the parameter for the given task.

Specified by:

getParamValue in interface TaskParamDescriptorModel

Parameters:

task - the task object

Returns:

the parameter value

getShapeFieldIndex

public int getShapeFieldIndex()

getOIDFieldIndex

public int getOIDFieldIndex()

getGeometryDef

public com.esri.arcgisws.GeometryDef getGeometryDef()

getGeometryType

public com.esri.arcgisws.EsriGeometryType getGeometryType()

getFields

public com.esri.arcgisws.Field[] getFields()

generateXML

public org.w3c.dom.Element generateXML(java.lang.Object task)

Description copied from interface: TaskParamDescriptorModel

Generates the XML content for this parameter. This XML is then transformed by the XSL used by the task control to generate the appropriate markup.

Note that if you implement this method and generate custom XML, you'll also need to provide the XSL that transforms this XML into the appropriate markup. The XSL file that the task control should use can be specified by using the xslFile attribute of the task tag.

Specified by:

generateXML in interface TaskParamDescriptorModel

Parameters:

task - the task object

Returns:

the generated XML Element

decodeXML

public java.lang.Object decodeXML(java.lang.Object task,
                                  org.w3c.dom.Element element)

Specified by:

decodeXML in interface CompositeTaskParamDescriptorModel

getName

public java.lang.String getName()

Description copied from interface: TaskParamDescriptorModel

Returns the name of the parameter.

If your task class has a pair of setParam(paramValue) and getParam() (isParam() for booleans) methods, the name of your parameter is param.

Specified by:

getName in interface TaskParamDescriptorModel

Returns:

the name of the parameter

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: TaskParamDescriptorModel

Returns the display text for the parameter. The value returned by this method is typically used to display the label for the parameter.

Specified by:

getDisplayName in interface TaskParamDescriptorModel

Returns:

the display text for the parameter

getRendererType

public java.lang.String getRendererType()

Description copied from interface: TaskParamDescriptorModel

Returns the renderer type for the parameter. The renderers supported out of the box are text boxes, checkboxes, radio buttons and dropdowns.

Specified by:

getRendererType in interface TaskParamDescriptorModel

Returns:

the renderer type for the parameter

createResultNode

public ResultNode createResultNode(java.lang.String jobID)

Specified by:

createResultNode in interface GPParam