com.esri.arcgis.datasourcesraster
Interface IAISClientObjectX

All Superinterfaces:

Serializable

All Known Implementing Classes:

IAISClientObjectXProxy

public interface IAISClientObjectX
extends Serializable

IAISClientObject Interface

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

boolean	close() Shuts down and cleans up the Client object.
String	getServerInfo(String requestString) Gets the information on the Server.
String	getStatus() Returns an XML detailing the status of the last operation performed on this object.
float	getVersion(String serverHost, String serverPort) Returns the version number of Server on specified host and port.
boolean	init(String iscConfig) initialize the Server Connection with an ISCConfig file/string.
IAISImageServiceX	openImageService(String imageServiceSource, String serviceInitializationProperties) Opens an image service as defined by the fully qualified
void	report(String statusString) This function is intended for internal use by other Image Service objects.

Method Detail

init

boolean init(String iscConfig)
             throws IOException,
                    AutomationException

initialize the Server Connection with an ISCConfig file/string.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

iscConfig - The iscConfig (in)

Returns:

The retVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

close

boolean close()
              throws IOException,
                     AutomationException

Shuts down and cleans up the Client object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The retVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVersion

float getVersion(String serverHost,
                 String serverPort)
                 throws IOException,
                        AutomationException

Returns the version number of Server on specified host and port. An empty port will use the default server port

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

serverHost - The serverHost (in)

serverPort - The serverPort (in)

Returns:

The version

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getServerInfo

String getServerInfo(String requestString)
                     throws IOException,
                            AutomationException

Gets the information on the Server.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

requestString - The requestString (in)

Returns:

The serverInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openImageService

IAISImageServiceX openImageService(String imageServiceSource,
                                   String serviceInitializationProperties)
                                   throws IOException,
                                          AutomationException

Opens an image service as defined by the fully qualified

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

imageServiceSource - The imageServiceSource (in)

serviceInitializationProperties - The serviceInitializationProperties (in)

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IAISImageServiceX

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStatus

String getStatus()
                 throws IOException,
                        AutomationException

Returns an XML detailing the status of the last operation performed on this object.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

The status

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

report

void report(String statusString)
            throws IOException,
                   AutomationException

This function is intended for internal use by other Image Service objects.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

statusString - The statusString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.