public class

GPTaskInfo

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

Class Overview

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

Summary

Nested Classes
enum GPTaskInfo.ExecutionType The Enum ExecutionType. 
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
 
enum GPTaskInfo.ParamDirection The Enum ParamDirection. 
enum GPTaskInfo.ParamType The Enum ParamType. 
Public Constructors
GPTaskInfo()
Public Methods
static GPTaskInfo fromJson(JsonParser parser)
Create a GPTaskInfo instance from the json contained in the given JsonParser object.
static GPTaskInfo fromUrl(String url, UserCredentials credentials)
Create a GPTaskInfo instance for the task at the given url.
static GPTaskInfo fromUrl(String url)
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.
GPParameterInfo[] getParameters()
Gets the parameters.
Protected Methods
void setCategory(String category)
Sets the category.
void setDisplayName(String displayName)
Sets the display name.
void setExecutionType(GPTaskInfo.ExecutionType execType)
Sets the execution type.
void setHelpUrl(String helpUrl)
Sets the help url.
void setName(String name)
Sets the name.
void setParameters(GPParameterInfo[] parameterInfo)
Sets the parameters.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public GPTaskInfo ()

Public Methods

public static GPTaskInfo fromJson (JsonParser parser)

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

Parameters
parser the parser
Returns
  • the GP task info
Throws
Exception
Exception

public static GPTaskInfo fromUrl (String url, UserCredentials credentials)

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
Exception

public static GPTaskInfo fromUrl (String url)

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
Exception

public String getCategory ()

Gets the category.

Returns
  • the category

public String getDisplayName ()

Gets the display name.

Returns
  • the display name

public GPTaskInfo.ExecutionType getExecutionType ()

Gets the execution type.

Returns
  • the execution type

public String getHelpUrl ()

Gets the help url.

Returns
  • the help url

public String getName ()

Gets the name.

Returns
  • the name

public GPParameterInfo[] getParameters ()

Gets the parameters.

Returns
  • the parameters

Protected Methods

protected void setCategory (String category)

Sets the category.

Parameters
category the new category

protected void setDisplayName (String displayName)

Sets the display name.

Parameters
displayName the new display name

protected void setExecutionType (GPTaskInfo.ExecutionType execType)

Sets the execution type.

Parameters
execType the new execution type

protected void setHelpUrl (String helpUrl)

Sets the help url.

Parameters
helpUrl the new help url

protected void setName (String name)

Sets the name.

Parameters
name the new name

protected void setParameters (GPParameterInfo[] parameterInfo)

Sets the parameters.

Parameters
parameterInfo the new parameters