com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class SharePackage

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.datamanagementtools.SharePackage
All Implemented Interfaces:
GPTool

public class SharePackage
extends AbstractGPTool

Shares a package by publishing to ArcGIS Online. The Share Package tool is contained in the Data Management Tools tool box.


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
SharePackage()
          Creates the Share Package tool with defaults.
SharePackage(Object inputFile, String username, Object password)
          Creates the Share Package tool with the required parameters.
 
Method Summary
 Object getInputFile()
          Returns the Input Package parameter of this tool .
 String getOutResults()
          Returns the Tool Succeeded parameter of this tool (Read only).
 Object getPassword()
          Returns the Password parameter of this tool .
 String getToolboxAlias()
          Returns the alias of the tool box containing this tool.
 String getToolboxName()
          Returns the name of the tool box containing this tool.
 String getToolName()
          Returns the name of this tool.
 String getUsername()
          Returns the Username parameter of this tool .
 void setInputFile(Object inputFile)
          Sets the Input Package parameter of this tool .
 void setPassword(Object password)
          Sets the Password parameter of this tool .
 void setUsername(String username)
          Sets the Username parameter of this tool .
 
Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
getParameterValues, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SharePackage

public SharePackage()
Creates the Share Package tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.


SharePackage

public SharePackage(Object inputFile,
                    String username,
                    Object password)
Creates the Share Package tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:
inputFile - null
username - eSRI global account username.
password - eSRI global account password.
Method Detail

getInputFile

public Object getInputFile()
Returns the Input Package parameter of this tool . This is a required parameter.

Returns:
the Input Package

setInputFile

public void setInputFile(Object inputFile)
Sets the Input Package parameter of this tool . This is a required parameter.

Parameters:
inputFile - null

getUsername

public String getUsername()
Returns the Username parameter of this tool . This parameter is eSRI global account username. This is a required parameter.

Returns:
the Username

setUsername

public void setUsername(String username)
Sets the Username parameter of this tool . This parameter is eSRI global account username. This is a required parameter.

Parameters:
username - eSRI global account username.

getPassword

public Object getPassword()
Returns the Password parameter of this tool . This parameter is eSRI global account password. This is a required parameter.

Returns:
the Password

setPassword

public void setPassword(Object password)
Sets the Password parameter of this tool . This parameter is eSRI global account password. This is a required parameter.

Parameters:
password - eSRI global account password.

getOutResults

public String getOutResults()
Returns the Tool Succeeded parameter of this tool (Read only). This is an derived parameter.

Returns:
the Tool Succeeded

getToolName

public String getToolName()
Returns the name of this tool.

Returns:
the tool name

getToolboxName

public String getToolboxName()
Returns the name of the tool box containing this tool.

Returns:
the tool box name

getToolboxAlias

public String getToolboxAlias()
Returns the alias of the tool box containing this tool.

Returns:
the tool box alias