Package com.esri.arcgisruntime.tasks.geoprocessing

Class GeoprocessingParameterInfo

java.lang.Object

com.esri.arcgisruntime.tasks.geoprocessing.GeoprocessingParameterInfo

public final class GeoprocessingParameterInfo
extends Object

Provides information on a single input or output parameter of a geoprocessing task.

GeoprocessingParameterInfo instances are retrieved from a GeoprocessingTaskInfo by calling GeoprocessingTaskInfo.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

Modifier and Type	Method	Description
String	getCategory()	Returns the geoprocessing parameter's category.
List<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 new GeoprocessingParameter set to the default value for this parameter info instance.
String	getDescription()	Returns the description for this parameter.
GeoprocessingParameterInfo.Direction	getDirection()	Returns the geoprocessing parameter's direction: either input or output.
String	getDisplayName()	Returns the geoprocessing parameter's display name.
GeoprocessingParameter.Type	getMultiValueDataType()	Returns the GeoprocessingParameter.Type of the GeoprocessingMultiValue if this parameter info is for a multi-value parameter, otherwise GeoprocessingParameter.Type.GEOPROCESSING_UNKNOWN_PARAMETER is returned.
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.

Methods inherited from class java.lang.Object

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

Method Detail

getCategory

public String getCategory()

Returns the geoprocessing parameter's category.

Returns:

the category

Since:

100.1.0

getDescription

public String getDescription()

Returns the description for this parameter.

Returns:

the description

Since:

100.1.0

getDisplayName

public String getDisplayName()

Returns the geoprocessing parameter's display name.

Returns:

the display name

Since:

100.1.0

getName

public 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 the GeoprocessingParameter.Type of the GeoprocessingMultiValue if this parameter info is for a multi-value parameter, otherwise GeoprocessingParameter.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 List<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 new GeoprocessingParameter 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