com.esri.arcgis.geoprocessing.tools.schematicstools
Class CreateSchematicFolder

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.schematicstools.CreateSchematicFolder

All Implemented Interfaces:

GPTool

public class CreateSchematicFolder
extends AbstractGPTool

Creates a schematic folder in a schematic dataset or schematic folder. The Create Schematic Folder tool is contained in the Schematics Tools tool box.

Usage tips:

• The output schematic folder must not exist. (The Overwrite output of geoprocessing setting has no effect.)

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

CreateSchematicFolder()
Creates the Create Schematic Folder tool with defaults.

CreateSchematicFolder(Object outLocation, String outName)
Creates the Create Schematic Folder tool with the required parameters.

Method Summary

Object	getOutLocation() Returns the Output Location parameter of this tool .
String	getOutName() Returns the Output Schematic Folder Name parameter of this tool .
Object	getOutSchematicFolder() Returns the Schematic Folder parameter of this tool (Read only).
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.
void	setOutLocation(Object outLocation) Sets the Output Location parameter of this tool .
void	setOutName(String outName) Sets the Output Schematic Folder Name 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

CreateSchematicFolder

public CreateSchematicFolder()

Creates the Create Schematic Folder tool with defaults.

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

CreateSchematicFolder

public CreateSchematicFolder(Object outLocation,
                             String outName)

Creates the Create Schematic Folder 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:

outLocation - the schematic dataset or schematic folder in which the folder will be created. This container must already exist.

outName - name of the output schematic folder.

Method Detail

getOutLocation

public Object getOutLocation()

Returns the Output Location parameter of this tool . This parameter is the schematic dataset or schematic folder in which the folder will be created. This container must already exist. This is a required parameter.

Returns:

the Output Location

setOutLocation

public void setOutLocation(Object outLocation)

Sets the Output Location parameter of this tool . This parameter is the schematic dataset or schematic folder in which the folder will be created. This container must already exist. This is a required parameter.

Parameters:

outLocation - the schematic dataset or schematic folder in which the folder will be created. This container must already exist.

getOutName

public String getOutName()

Returns the Output Schematic Folder Name parameter of this tool . This parameter is name of the output schematic folder. This is a required parameter.

Returns:

the Output Schematic Folder Name

setOutName

public void setOutName(String outName)

Sets the Output Schematic Folder Name parameter of this tool . This parameter is name of the output schematic folder. This is a required parameter.

Parameters:

outName - name of the output schematic folder.

getOutSchematicFolder

public Object getOutSchematicFolder()

Returns the Schematic Folder parameter of this tool (Read only). This is an derived parameter.

Returns:

the Schematic Folder

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