public static class

GPTaskInfo.GPParameterInfo

extends Object
java.lang.Object
   ↳ com.esri.core.tasks.ags.geoprocessing.GPTaskInfo.GPParameterInfo

Class Overview

This class provides information on a single parameter of a geoprocessing task. Information includes:

  • Parameter name
  • Parameter display name
  • The parameter's category, if any
  • The parameter's type
  • The parameters direction: in or out
  • The default value
  • The parameter type: required, optional or derived
  • A list of value choices

Summary

Public Constructors
GPTaskInfo.GPParameterInfo()
Public Methods
static GPTaskInfo.GPParameterInfo fromJson(JsonParser parser)
Create a GPParameterInfo instance from the Json contained in the given JsonParser object.
String getCategory()
Gets the category.
String[] getChoiceList()
Gets the choice list.
Class<?> getDataType()
Gets the data type.
GPParameter getDefaultValue()
Gets the default value.
GPTaskInfo.ParamDirection getDirection()
Gets the direction.
String getDisplayName()
Gets the display name.
String getName()
Gets the parameter's name.
GPTaskInfo.ParamType getParameterType()
Gets the parameter type.
Protected Methods
void setCategory(String category)
Sets the category.
void setChoiceList(String[] choiceList)
Sets the choice list.
void setDataType(String dataType)
Sets the data type.
void setDefaultValue(GPParameter defaultValue)
Sets the default value.
void setDirection(GPTaskInfo.ParamDirection direction)
Sets the direction.
void setDisplayName(String displayName)
Sets the display name.
void setName(String name)
Sets the name.
void setParameterType(GPTaskInfo.ParamType type)
Sets the parameter type.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GPTaskInfo.GPParameterInfo ()

Public Methods

public static GPTaskInfo.GPParameterInfo fromJson (JsonParser parser)

Create a GPParameterInfo instance from the Json contained in the given JsonParser object.

Parameters
parser JsonParser: the Json parser
Returns
GPTaskInfo.GPParameterInfo the GP parameter info
Throws
Exception when the Json cannot be parsed

public String getCategory ()

Gets the category.

Returns
String the category

public String[] getChoiceList ()

Gets the choice list.

Returns
String[] the choice list

public Class<?> getDataType ()

Gets the data type.

Returns
Class<?> the data type

public GPParameter getDefaultValue ()

Gets the default value.

Returns
GPParameter the default value

public GPTaskInfo.ParamDirection getDirection ()

Gets the direction.

Returns
GPTaskInfo.ParamDirection the direction

public String getDisplayName ()

Gets the display name.

Returns
String the display name

public String getName ()

Gets the parameter's name.

Returns
String the parameter name

public GPTaskInfo.ParamType getParameterType ()

Gets the parameter type.

Returns
GPTaskInfo.ParamType the parameter type

Protected Methods

protected void setCategory (String category)

Sets the category.

Parameters
category String: the new category

protected void setChoiceList (String[] choiceList)

Sets the choice list.

Parameters
choiceList String: the new choice list

protected void setDataType (String dataType)

Sets the data type.

Parameters
dataType String: the new data type

protected void setDefaultValue (GPParameter defaultValue)

Sets the default value.

Parameters
defaultValue GPParameter: the new default value

protected void setDirection (GPTaskInfo.ParamDirection direction)

Sets the direction.

Parameters
direction GPTaskInfo.ParamDirection: the new direction

protected void setDisplayName (String displayName)

Sets the display name.

Parameters
displayName String: the new display name

protected void setName (String name)

Sets the name.

Parameters
name String: the new name

protected void setParameterType (GPTaskInfo.ParamType type)

Sets the parameter type.

Parameters
type GPTaskInfo.ParamType: the new parameter type