|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.esri.adf.web.ags.data.gp.GPStringParam
public class GPStringParam
Field Summary | |
---|---|
static String |
GP_DATA_TYPE
|
Constructor Summary | |
---|---|
GPStringParam()
|
Method Summary | |
---|---|
void |
afterTaskExecute(String jobID)
|
void |
beforeTaskExecute()
|
ResultNode |
createResultNode(String jobID)
|
Element |
generateXML(Object task)
Generates the XML content for this parameter. |
String |
getDisplayName()
Returns the display text for the parameter. |
String |
getDisplayText()
|
String |
getGPDataType()
|
com.esri.arcgisws.GPParameterInfo |
getGPParamInfo()
|
String |
getName()
Returns the name of the parameter. |
Object |
getParamValue(Object task)
Returns the current value of the parameter for the given task. |
String |
getRendererType()
Returns the renderer type for the parameter. |
String |
getValue()
|
void |
initParam(AGSGPFunctionality gpFunc,
com.esri.arcgisws.GPParameterInfo paramInfo)
|
Object |
setParamValue(Object task,
String strVal)
Sets the parameter value on the task and returns the set value. |
void |
setValue(String value)
|
String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final String GP_DATA_TYPE
Constructor Detail |
---|
public GPStringParam()
Method Detail |
---|
public void initParam(AGSGPFunctionality gpFunc, com.esri.arcgisws.GPParameterInfo paramInfo)
initParam
in interface GPParam
public String getGPDataType()
getGPDataType
in interface GPParam
public String getValue()
public void setValue(String value)
public String toString()
toString
in class Object
public com.esri.arcgisws.GPParameterInfo getGPParamInfo()
getGPParamInfo
in interface GPParam
public Object setParamValue(Object task, String strVal)
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.
setParamValue
in interface TaskParamDescriptorModel
task
- the task object on which to set the parameter valuestrVal
- the string representation of the parameter value to be set
public Object getParamValue(Object task)
TaskParamDescriptorModel
Returns the current value of the parameter for the given task.
getParamValue
in interface TaskParamDescriptorModel
task
- the task object
public Element generateXML(Object task)
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.
generateXML
in interface TaskParamDescriptorModel
task
- the task object
Element
public String getName()
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
.
getName
in interface TaskParamDescriptorModel
public String getDisplayName()
TaskParamDescriptorModel
getDisplayName
in interface TaskParamDescriptorModel
public String getRendererType()
TaskParamDescriptorModel
Returns the renderer type for the parameter. The renderers supported out of the box are text boxes, checkboxes, radio buttons and dropdowns.
getRendererType
in interface TaskParamDescriptorModel
public String getDisplayText()
public ResultNode createResultNode(String jobID)
createResultNode
in interface GPParam
public void beforeTaskExecute()
beforeTaskExecute
in interface GPParam
public void afterTaskExecute(String jobID)
afterTaskExecute
in interface GPParam
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |