Class GeoprocessingParameterInfo
- java.lang.Object
-
- com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingParameterInfo
-
public final class GeoprocessingParameterInfo extends java.lang.Object
Provides information on a single input or output parameter of a geoprocessing task.GeoprocessingParameterInfo instances are retrieved from a
GeoprocessingTaskInfo
by callingGeoprocessingTaskInfo.getParameterInfos()
. Each instance in the list gives the parameter's name and type along with a property indicating whether or not it is optional (for input parameters) and whether it is an input or output parameter.- Since:
- 100.1.0
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GeoprocessingParameterInfo.Direction
Defines whether a GeoprocessingParameterInfo represents an input or an output parameter.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getCategory()
Returns the geoprocessing parameter's category.java.util.List<java.lang.String>
getChoiceList()
Returns an unmodifiable list of value choices for this parameter.GeoprocessingParameter.Type
getDataType()
Returns the geoprocessing parameter's data type.GeoprocessingParameter
getDefaultValue()
Returns a newGeoprocessingParameter
set to the default value for this parameter info instance.java.lang.String
getDescription()
Returns the description for this parameter.GeoprocessingParameterInfo.Direction
getDirection()
Returns the geoprocessing parameter's direction: either input or output.java.lang.String
getDisplayName()
Returns the geoprocessing parameter's display name.GeoprocessingParameter.Type
getMultiValueDataType()
Returns theGeoprocessingParameter.Type
of theGeoprocessingMultiValue
if this parameter info is for a multi-value parameter, otherwiseGeoprocessingParameter.Type.GEOPROCESSING_UNKNOWN_PARAMETER
is returned.java.lang.String
getName()
Returns the geoprocessing parameter's name.boolean
isFeaturesRequireGeometry()
Returns whether or not a geoprocessing feature parameter requires features with geometry.boolean
isRequired()
Returns whether or not this geoprocessing parameter is required.
-
-
-
Method Detail
-
getCategory
public java.lang.String getCategory()
Returns the geoprocessing parameter's category.- Returns:
- the category
- Since:
- 100.1.0
-
getDescription
public java.lang.String getDescription()
Returns the description for this parameter.- Returns:
- the description
- Since:
- 100.1.0
-
getDisplayName
public java.lang.String getDisplayName()
Returns the geoprocessing parameter's display name.- Returns:
- the display name
- Since:
- 100.1.0
-
getName
public java.lang.String getName()
Returns the geoprocessing parameter's name.- Returns:
- the name
- Since:
- 100.1.0
-
isRequired
public boolean isRequired()
Returns whether or not this geoprocessing parameter is required.- Returns:
- true if this parameter is required, false otherwise
- Since:
- 100.1.0
-
getDirection
public GeoprocessingParameterInfo.Direction getDirection()
Returns the geoprocessing parameter's direction: either input or output.- Returns:
- the direction
- Since:
- 100.1.0
-
getDataType
public GeoprocessingParameter.Type getDataType()
Returns the geoprocessing parameter's data type.- Returns:
- the data type
- Since:
- 100.1.0
-
getMultiValueDataType
public GeoprocessingParameter.Type getMultiValueDataType()
Returns theGeoprocessingParameter.Type
of theGeoprocessingMultiValue
if this parameter info is for a multi-value parameter, otherwiseGeoprocessingParameter.Type.GEOPROCESSING_UNKNOWN_PARAMETER
is returned.- Returns:
- the multi-value data type or unknown if this is not a multi-value parameter
- Since:
- 100.1.0
-
getChoiceList
public java.util.List<java.lang.String> getChoiceList()
Returns an unmodifiable list of value choices for this parameter.- Returns:
- a list of choices
- Since:
- 100.1.0
-
getDefaultValue
public GeoprocessingParameter getDefaultValue()
Returns a newGeoprocessingParameter
set to the default value for this parameter info instance.- Returns:
- a parameter instance
- Since:
- 100.1.0
-
isFeaturesRequireGeometry
public boolean isFeaturesRequireGeometry()
Returns whether or not a geoprocessing feature parameter requires features with geometry.- Returns:
- true if this feature parameter requires geometry, false otherwise
- Since:
- 100.1.0
-
-