com.esri.core.tasks.ags.geoprocessing
Class GPTaskInfo.GPParameterInfo

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

Enclosing class:

GPTaskInfo

public static class GPTaskInfo.GPParameterInfo
extends Object

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

Since:

10.1.1

Constructor Summary

GPTaskInfo.GPParameterInfo()

Method Summary

static GPTaskInfo.GPParameterInfo	fromJson(org.codehaus.jackson.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 name.
GPTaskInfo.ParamType	getParameterType() Gets the parameter type.
protected void	setCategory(String category) Sets the category.
protected void	setChoiceList(String[] choiceList) Sets the choice list.
protected void	setDataType(String dataType) Sets the data type.
protected void	setDefaultValue(GPParameter defaultValue) Sets the default value.
protected void	setDirection(GPTaskInfo.ParamDirection direction) Sets the direction.
protected void	setDisplayName(String displayName) Sets the display name.
protected void	setName(String name) Sets the name.
protected void	setParameterType(GPTaskInfo.ParamType type) Sets the parameter type.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPTaskInfo.GPParameterInfo

public GPTaskInfo.GPParameterInfo()

Method Detail

fromJson

public static GPTaskInfo.GPParameterInfo fromJson(org.codehaus.jackson.JsonParser parser)
                                           throws Exception

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

Parameters:

parser - the parser

Returns:

the GP parameter info

Throws:

Exception

Since:

10.1.1

setName

protected void setName(String name)

Sets the name.

Parameters:

name - the new name

getName

public String getName()

Gets the name.

Returns:

the name

Since:

10.1.1

setDisplayName

protected void setDisplayName(String displayName)

Sets the display name.

Parameters:

displayName - the new display name

getDisplayName

public String getDisplayName()

Gets the display name.

Returns:

the display name

Since:

10.1.1

setCategory

protected void setCategory(String category)

Sets the category.

Parameters:

category - the new category

getCategory

public String getCategory()

Gets the category.

Returns:

the category

Since:

10.1.1

setDataType

protected void setDataType(String dataType)

Sets the data type.

Parameters:

dataType - the new data type

getDataType

public Class<?> getDataType()

Gets the data type.

Returns:

the data type

Since:

10.1.1

setDirection

protected void setDirection(GPTaskInfo.ParamDirection direction)

Sets the direction.

Parameters:

direction - the new direction

getDirection

public GPTaskInfo.ParamDirection getDirection()

Gets the direction.

Returns:

the direction

Since:

10.1.1

setParameterType

protected void setParameterType(GPTaskInfo.ParamType type)

Sets the parameter type.

Parameters:

type - the new parameter type

getParameterType

public GPTaskInfo.ParamType getParameterType()

Gets the parameter type.

Returns:

the parameter type

Since:

10.1.1

setChoiceList

protected void setChoiceList(String[] choiceList)

Sets the choice list.

Parameters:

choiceList - the new choice list

getChoiceList

public String[] getChoiceList()

Gets the choice list.

Returns:

the choice list

Since:

10.1.1

setDefaultValue

protected void setDefaultValue(GPParameter defaultValue)

Sets the default value.

Parameters:

defaultValue - the new default value

getDefaultValue

public GPParameter getDefaultValue()

Gets the default value.

Returns:

the default value

Since:

10.1.1