com.esri.arcgis.carto
Interface IMapServerInit

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
IMapServerInit2
All Known Implementing Classes:
IMapServerInit2Proxy, IMapServerInitProxy, MapServer

public interface IMapServerInit
extends java.io.Serializable

COM Interface 'IMapServerInit'. Generated 3/19/2015 1:20:53 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'Provides access to members that support initializing a map server.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =


Field Summary
static java.lang.String IID
          Deprecated. Internal use only
static int IID56e179e3_974e_41a7_836b_c9a60ef6301b
           
static int xxDummy
          Deprecated. Internal use only
 
Method Summary
 void connect(java.lang.String filePath)
          Initializes the map server with an mxd or pmf file stored at the specified path.
 java.lang.String getFilePath()
          The map document path.
 int getMaxBufferCount()
          The maximum number of records buffered on the server for display.
 int getMaxImageHeight()
          The maximum height in pixels of an image request.
 int getMaxImageWidth()
          The maximum width in pixels of an image request.
 int getMaxRecordCount()
          The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).
 java.lang.String getPhysicalOutputDirectory()
          The physical directory for output files.
 java.lang.String getVirtualOutputDirectory()
          The virtual directory for output files.
 void setMaxBufferCount(int count)
          The maximum number of records buffered on the server for display.
 void setMaxImageHeight(int height)
          The maximum height in pixels of an image request.
 void setMaxImageWidth(int width)
          The maximum width in pixels of an image request.
 void setMaxRecordCount(int count)
          The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).
 void setPhysicalOutputDirectory(java.lang.String dirPath)
          The physical directory for output files.
 void setVirtualOutputDirectory(java.lang.String dirPath)
          The virtual directory for output files.
 void startWithData(IDataset pDataset)
          An alternative to calling Connect().
 void stop()
          Clears out all of the map objects in memory.
 

Field Detail

IID56e179e3_974e_41a7_836b_c9a60ef6301b

static final int IID56e179e3_974e_41a7_836b_c9a60ef6301b
See Also:
Constant Field Values

xxDummy

static final int xxDummy
Deprecated. Internal use only
See Also:
Constant Field Values

IID

static final java.lang.String IID
Deprecated. Internal use only
See Also:
Constant Field Values
Method Detail

connect

void connect(java.lang.String filePath)
             throws java.io.IOException,
                    AutomationException
Initializes the map server with an mxd or pmf file stored at the specified path. The path must be accessible to the server machine.

Parameters:
filePath - The filePath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

startWithData

void startWithData(IDataset pDataset)
                   throws java.io.IOException,
                          AutomationException
An alternative to calling Connect(). This method synthesizes a map document with a single layer based on the given IDataset object and initializes the map server for processing.

Parameters:
pDataset - A reference to a com.esri.arcgis.geodatabase.IDataset (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

stop

void stop()
          throws java.io.IOException,
                 AutomationException
Clears out all of the map objects in memory. The client must call one of the Start methods again before attempting any other operations.

Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPhysicalOutputDirectory

void setPhysicalOutputDirectory(java.lang.String dirPath)
                                throws java.io.IOException,
                                       AutomationException
The physical directory for output files.

Parameters:
dirPath - The dirPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPhysicalOutputDirectory

java.lang.String getPhysicalOutputDirectory()
                                            throws java.io.IOException,
                                                   AutomationException
The physical directory for output files.

Returns:
The dirPath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setVirtualOutputDirectory

void setVirtualOutputDirectory(java.lang.String dirPath)
                               throws java.io.IOException,
                                      AutomationException
The virtual directory for output files.

Parameters:
dirPath - The dirPath (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getVirtualOutputDirectory

java.lang.String getVirtualOutputDirectory()
                                           throws java.io.IOException,
                                                  AutomationException
The virtual directory for output files.

Returns:
The dirPath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFilePath

java.lang.String getFilePath()
                             throws java.io.IOException,
                                    AutomationException
The map document path.

Returns:
The filePath
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxRecordCount

int getMaxRecordCount()
                      throws java.io.IOException,
                             AutomationException
The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).

Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxRecordCount

void setMaxRecordCount(int count)
                       throws java.io.IOException,
                              AutomationException
The maximum number of records returned for query results (Identify, Find, QueryFeatureData, and QueryHyperlinks).

Parameters:
count - The count (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxBufferCount

int getMaxBufferCount()
                      throws java.io.IOException,
                             AutomationException
The maximum number of records buffered on the server for display.

Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxBufferCount

void setMaxBufferCount(int count)
                       throws java.io.IOException,
                              AutomationException
The maximum number of records buffered on the server for display.

Parameters:
count - The count (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxImageWidth

int getMaxImageWidth()
                     throws java.io.IOException,
                            AutomationException
The maximum width in pixels of an image request.

Returns:
The width
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxImageWidth

void setMaxImageWidth(int width)
                      throws java.io.IOException,
                             AutomationException
The maximum width in pixels of an image request.

Parameters:
width - The width (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaxImageHeight

int getMaxImageHeight()
                      throws java.io.IOException,
                             AutomationException
The maximum height in pixels of an image request.

Returns:
The height
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaxImageHeight

void setMaxImageHeight(int height)
                       throws java.io.IOException,
                              AutomationException
The maximum height in pixels of an image request.

Parameters:
height - The height (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.