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

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

public class UpdateDiagrams
extends AbstractGPTool

The Update Diagrams tool is contained in the Schematics Tools tool box.


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
UpdateDiagrams()
          Creates the Update Diagrams tool with defaults.
UpdateDiagrams(Object inContainer)
          Creates the Update Diagrams tool with the required parameters.
 
Method Summary
 String getBuilderOptions()
          Returns the Builder Options parameter of this tool .
 String getDiagramType()
          Returns the Diagram Type parameter of this tool .
 Object getInContainer()
          Returns the Input Schematic Container parameter of this tool .
 int getLastUpdateCriteria()
          Returns the Number of days without update parameter of this tool .
 Object getOutContainer()
          Returns the Output Schematic Container parameter of this tool (Read only).
 String getRecursive()
          Returns the Recursive Search 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.
 void setBuilderOptions(String builderOptions)
          Sets the Builder Options parameter of this tool .
 void setDiagramType(String diagramType)
          Sets the Diagram Type parameter of this tool .
 void setInContainer(Object inContainer)
          Sets the Input Schematic Container parameter of this tool .
 void setLastUpdateCriteria(int lastUpdateCriteria)
          Sets the Number of days without update parameter of this tool .
 void setRecursive(String recursive)
          Sets the Recursive Search 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

UpdateDiagrams

public UpdateDiagrams()
Creates the Update Diagrams tool with defaults.

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


UpdateDiagrams

public UpdateDiagrams(Object inContainer)
Creates the Update Diagrams 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:
inContainer - null
Method Detail

getInContainer

public Object getInContainer()
Returns the Input Schematic Container parameter of this tool . This is a required parameter.

Returns:
the Input Schematic Container

setInContainer

public void setInContainer(Object inContainer)
Sets the Input Schematic Container parameter of this tool . This is a required parameter.

Parameters:
inContainer - null

getBuilderOptions

public String getBuilderOptions()
Returns the Builder Options parameter of this tool . This is an optional parameter.

Returns:
the Builder Options

setBuilderOptions

public void setBuilderOptions(String builderOptions)
Sets the Builder Options parameter of this tool . This is an optional parameter.

Parameters:
builderOptions - null

getRecursive

public String getRecursive()
Returns the Recursive Search parameter of this tool . This is an optional parameter.

Returns:
the Recursive Search

setRecursive

public void setRecursive(String recursive)
Sets the Recursive Search parameter of this tool . This is an optional parameter.

Parameters:
recursive - null

getDiagramType

public String getDiagramType()
Returns the Diagram Type parameter of this tool . This is an optional parameter.

Returns:
the Diagram Type

setDiagramType

public void setDiagramType(String diagramType)
Sets the Diagram Type parameter of this tool . This is an optional parameter.

Parameters:
diagramType - null

getLastUpdateCriteria

public int getLastUpdateCriteria()
Returns the Number of days without update parameter of this tool . This is an optional parameter.

Returns:
the Number of days without update

setLastUpdateCriteria

public void setLastUpdateCriteria(int lastUpdateCriteria)
Sets the Number of days without update parameter of this tool . This is an optional parameter.

Parameters:
lastUpdateCriteria - null

getOutContainer

public Object getOutContainer()
Returns the Output Schematic Container parameter of this tool (Read only). This is an derived parameter.

Returns:
the Output Schematic Container

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