com.esri.arcgis.geoprocessing.tools.servertools
Class ManageMapServerCacheScales

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.servertools.ManageMapServerCacheScales

All Implemented Interfaces:

GPTool

public class ManageMapServerCacheScales
extends AbstractGPTool

Updates the scale levels in an existing cached map service. Use this tool to add new scales or delete existing scales from a map cache. The Manage Map Server Cache Scales tool is contained in the Server Tools tool box.

Usage tips:

• If you remove scales from an existing cache, it will permanently delete all existing cached tiles within that level of detail.

Field Summary

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

vals

Constructor Summary

ManageMapServerCacheScales()
Creates the Manage Map Server Cache Scales tool with defaults.

ManageMapServerCacheScales(String serverName, String objectName, Object levels)
Creates the Manage Map Server Cache Scales tool with the required parameters.

Method Summary

Object	getLevels() Returns the Scales parameter of this tool .
String	getObjectName() Returns the Map Server parameter of this tool .
String	getOutObjectName() Returns the Output Map Server parameter of this tool (Read only).
String	getOutServerName() Returns the Output Host parameter of this tool (Read only).
String	getServerName() Returns the Host 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	setLevels(Object levels) Sets the Scales parameter of this tool .
void	setObjectName(String objectName) Sets the Map Server parameter of this tool .
void	setServerName(String serverName) Sets the Host 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

ManageMapServerCacheScales

public ManageMapServerCacheScales()

Creates the Manage Map Server Cache Scales tool with defaults.

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

ManageMapServerCacheScales

public ManageMapServerCacheScales(String serverName,
                                  String objectName,
                                  Object levels)

Creates the Manage Map Server Cache Scales 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:

serverName - the ArcGIS Server machine hosting the service from which you want to remove cache scales.

objectName - the name of the map service from which you want to remove cache scales.

levels - the scale values to be included in the updated tiling scheme. you must specify existing scale values if you want to keep them. Any existing scale levels you do not specify in this tool will be permanently deleted. For example, if you have four existing scales and you wish to add two scales, make sure your final list has a total of six scales.

Method Detail

getServerName

public String getServerName()

Returns the Host parameter of this tool . This parameter is the ArcGIS Server machine hosting the service from which you want to remove cache scales. This is a required parameter.

Returns:

the Host

setServerName

public void setServerName(String serverName)

Sets the Host parameter of this tool . This parameter is the ArcGIS Server machine hosting the service from which you want to remove cache scales. This is a required parameter.

Parameters:

serverName - the ArcGIS Server machine hosting the service from which you want to remove cache scales.

getObjectName

public String getObjectName()

Returns the Map Server parameter of this tool . This parameter is the name of the map service from which you want to remove cache scales. This is a required parameter.

Returns:

the Map Server

setObjectName

public void setObjectName(String objectName)

Sets the Map Server parameter of this tool . This parameter is the name of the map service from which you want to remove cache scales. This is a required parameter.

Parameters:

objectName - the name of the map service from which you want to remove cache scales.

getLevels

public Object getLevels()

Returns the Scales parameter of this tool . This parameter is the scale values to be included in the updated tiling scheme. you must specify existing scale values if you want to keep them. Any existing scale levels you do not specify in this tool will be permanently deleted. For example, if you have four existing scales and you wish to add two scales, make sure your final list has a total of six scales. This is a required parameter.

Returns:

the Scales

setLevels

public void setLevels(Object levels)

Sets the Scales parameter of this tool . This parameter is the scale values to be included in the updated tiling scheme. you must specify existing scale values if you want to keep them. Any existing scale levels you do not specify in this tool will be permanently deleted. For example, if you have four existing scales and you wish to add two scales, make sure your final list has a total of six scales. This is a required parameter.

Parameters:

levels - the scale values to be included in the updated tiling scheme. you must specify existing scale values if you want to keep them. Any existing scale levels you do not specify in this tool will be permanently deleted. For example, if you have four existing scales and you wish to add two scales, make sure your final list has a total of six scales.

getOutServerName

public String getOutServerName()

Returns the Output Host parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Host

getOutObjectName

public String getOutObjectName()

Returns the Output Map Server parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Map Server

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