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

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

public class GPTaskInfo
extends Object

This class provides information on a geoprocessing task at a given url. Information includes:

• Task name
• Task display name
• The task's category, if any
• The help url, if any
• Whether the task is synchronous or asynchronous
• A list of task parameters

Since:

10.1.1

Nested Class Summary

static class	GPTaskInfo.ExecutionType The Enum ExecutionType.
static class	GPTaskInfo.GPParameterInfo 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
static class	GPTaskInfo.ParamDirection The Enum ParamDirection.
static class	GPTaskInfo.ParamType The Enum ParamType.

Constructor Summary

GPTaskInfo()

Method Summary

static GPTaskInfo	fromJson(org.codehaus.jackson.JsonParser parser) Create a GPTaskInfo instance from the json contained in the given JsonParser object.
static GPTaskInfo	fromUrl(String url) Create a GPTaskInfo instance for the task at the given url.
static GPTaskInfo	fromUrl(String url, UserCredentials credentials) Create a GPTaskInfo instance for the task at the given url.
String	getCategory() Gets the category.
String	getDisplayName() Gets the display name.
GPTaskInfo.ExecutionType	getExecutionType() Gets the execution type.
String	getHelpUrl() Gets the help url.
String	getName() Gets the name.
GPTaskInfo.GPParameterInfo[]	getParameters() Gets the parameters.
protected void	setCategory(String category) Sets the category.
protected void	setDisplayName(String displayName) Sets the display name.
protected void	setExecutionType(GPTaskInfo.ExecutionType execType) Sets the execution type.
protected void	setHelpUrl(String helpUrl) Sets the help url.
protected void	setName(String name) Sets the name.
protected void	setParameters(GPTaskInfo.GPParameterInfo[] parameterInfo) Sets the parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

GPTaskInfo

public GPTaskInfo()

Method Detail

fromUrl

public static GPTaskInfo fromUrl(String url)
                          throws Exception

Create a GPTaskInfo instance for the task at the given url. This method will query the service and return the task information.

Parameters:

url - the url of the task

Returns:

the GP task info

Throws:

Exception

Since:

10.1.1

fromUrl

public static GPTaskInfo fromUrl(String url,
                                 UserCredentials credentials)
                          throws Exception

Create a GPTaskInfo instance for the task at the given url. Login credentials are provided by the credentials parameter. This method will query the service and return the service information.

Parameters:

url - the url of the task

credentials - the credentials required to access the service

Returns:

the GP task info

Throws:

Exception

Since:

10.1.1

fromJson

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

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

Parameters:

parser - the parser

Returns:

the GP task 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

setHelpUrl

protected void setHelpUrl(String helpUrl)

Sets the help url.

Parameters:

helpUrl - the new help url

getHelpUrl

public String getHelpUrl()

Gets the help url.

Returns:

the help url

Since:

10.1.1

setExecutionType

protected void setExecutionType(GPTaskInfo.ExecutionType execType)

Sets the execution type.

Parameters:

execType - the new execution type

getExecutionType

public GPTaskInfo.ExecutionType getExecutionType()

Gets the execution type.

Returns:

the execution type

Since:

10.1.1

setParameters

protected void setParameters(GPTaskInfo.GPParameterInfo[] parameterInfo)

Sets the parameters.

Parameters:

parameterInfo - the new parameters

getParameters

public GPTaskInfo.GPParameterInfo[] getParameters()

Gets the parameters.

Returns:

the parameters

Since:

10.1.1