com.esri.arcgis.trackinganalyst
Class AMSWorkspaceFactory

java.lang.Object
  com.esri.arcgis.trackinganalyst.AMSWorkspaceFactory

All Implemented Interfaces:

IRemoteDatabaseWorkspaceFactory, IWorkspaceFactory, IWorkspaceFactory2, ITemporalWorkspaceStatistics, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class AMSWorkspaceFactory
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IWorkspaceFactory2, IWorkspaceFactory, IRemoteDatabaseWorkspaceFactory, ITemporalWorkspaceStatistics, ISupportErrorInfo

Controls functionality for the tracking workspace factory.

Description

The AMSWorkspaceFactory object is used to create AMS Workspace objects from connection properties or a connection file. The AMS Workspace object provides a connection to a dynamic data source such as the Tracking Server product. The default source for dynamic or near real time data is the Tracking Server. AMSWorkspaceFactory allows the user to:

• Read connection properties from the specified file.
• Get workspace description / workspace type.
• Copy / move a workspace to the specified destination folder.
• Retrieve workspace statistics

The table below summarizes all of the connection properties that can be invoked to instantiate an AMS workspace object.

Property Name	Required	Default Value	Description
SERVERNAME	Y	localhost	Name of Server or IP
AMS_CONNECTOR_EDITOR	Y	<None> Example {1C6BA545-2F59-11D5-B7E2-00010265ADC5}	The class id or progid of the Connections Editor. This editor object must implement IGxObject.
AMS_CONNECTION_NAME	Y	Tracking Connector	The Name or label of the connection.
AMS_CONNECTOR	Y	<none>	The progid or class id of the connector.
AMS_USER_NAME	Y	<none>	Name of user to Log into the tracking server.
AMS_ENABLED_PROVIDERS	O	<esri propertyset object>	Property set of enabled Tracking Services. If this property is not set or exists then all tracking services are assumed to be enabled.
TMS_USER_PWD	Y	<none>	Users Password
CONNECTOR_PORT	O	5506	The Client port of the tracking server
TMS_CMD_TIMEOUT	O	60	Command Response Timeout in seconds
TMS_CONNECT_RETRY	O	60	The time in seconds that the connector waits before it automatically retries ad dropped connection.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

See Also:

Serialized Form

Constructor Summary

AMSWorkspaceFactory()
Constructs a AMSWorkspaceFactory using ArcGIS Engine.

AMSWorkspaceFactory(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AMSWorkspaceFactory theAMSWorkspaceFactory = (AMSWorkspaceFactory) obj;

Method Summary

boolean	containsWorkspace(String parentDirectory, IFileNames fileNames) Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.
boolean	copy(IWorkspaceName workspaceName, String destinationFolder, IWorkspaceName[] workspaceNameCopy) Copies a workspace to the specified destination folder.
IWorkspaceName	create(String parentDirectory, String name, IPropertySet connectionProperties, int hWnd) Creates a new workspace specified by the directory, file name, and connection properties.
void	deleteConnectionFile(String pathName) Deletes the remote database workspace connection file.
IWorkspaceName	editConnectionFile(String pathName, int hWnd) Edits the properties of a remote database workspace connection file.
boolean	equals(Object o) Compare this object with another
IPropertySet	getAllMessageRates() Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllSampleSizes() Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllTotalFeatureCounts() Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.
IPropertySet	getAllTrackCounts() Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.
IUID	getClassID() The class ID of the WorkspaceFactory.
static String	getClsid() getClsid.
IPropertySet	getConnectionStatus() Indicates the connection status of each workspace under the workspace factory
IPropertySet	getCurrentDiscardedMessageCounts() Indicates current number of messages discarded.
IPropertySet	getDiscardedMessageCounts() Indicates total number of messages discarded.
IPropertySet	getPulledMessageCounts() Indicates total number of messages pulled.
IPropertySet	getQueuedMessageCounts() Indicates total number of messages queued.
IPropertySet	getReceivedMessageCounts() Indicates total number of messages received.
String	getWorkspaceDescription(boolean plural) A singular or plural description of the type of workspace the workspace factory opens/creates.
IWorkspaceName	getWorkspaceName(String parentDirectory, IFileNames fileNames) Retrieves the workspace name of a workspace from the given list of file names.
int	getWorkspaceType() The type of workspace the workspace factory opens/creates.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
boolean	isWorkspace(String fileName) True if the specified file identifies a workspace supported by the workspace factory.
boolean	move(IWorkspaceName workspaceName, String destinationFolder) Moves a workspace to the specified destination folder.
IWorkspace	open(IPropertySet connectionProperties, int hWnd) Opens the workspace specified by the connection properties.
IWorkspace	openFromFile(String fileName, int hWnd) Opens the workspace specified by the given file name.
IWorkspace	openFromString(String connectStr, int hWnd) Opens the workspace specified by a connection string.
IPropertySet	readConnectionPropertiesFromFile(String fileName) The connection properties from the specified file.
IWorkspaceName	renameConnectionFile(String oldPathName, String newName) Renames the remote database workspace connection file.
void	resetAllFeatureCounts() Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.
void	resetAllMessageRates() Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.
void	setAllSampleSizes(int lSampleSize) Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

AMSWorkspaceFactory

public AMSWorkspaceFactory()
                    throws IOException,
                           UnknownHostException

Constructs a AMSWorkspaceFactory using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

AMSWorkspaceFactory

public AMSWorkspaceFactory(Object obj)
                    throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
AMSWorkspaceFactory theAMSWorkspaceFactory = (AMSWorkspaceFactory) obj;

Construct a AMSWorkspaceFactory using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to AMSWorkspaceFactory.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

openFromString

public IWorkspace openFromString(String connectStr,
                                 int hWnd)
                          throws IOException,
                                 AutomationException

Opens the workspace specified by a connection string.

Remarks

The connect string is a collection of name value pairs separated by a semicolon (;).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

openFromString in interface IWorkspaceFactory2

Parameters:

connectStr - The connectStr (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

open

public IWorkspace open(IPropertySet connectionProperties,
                       int hWnd)
                throws IOException,
                       AutomationException

Opens the workspace specified by the connection properties.

Remarks

Open takes as input a property set of connection properties that specify the workspace to connect to. In the case of file system workspaces and local database workspaces, a single property named DATABASE, whose value is the pathname to the workspace, is usually all that is required. In the case of remote database workspaces accessed via ArcSDE the properties can include the USER, PASSWORD, DATABASE, SERVER, INSTANCE, VERSION, HISTORICAL_NAME, HISTORICAL_TIMESTAMP, and AUTHENTICATION_MODE properties of the database being connected to.

List of acceptable connection property names and a brief description of each

"SERVER" – SDE server name you are connecting to.

"INSTANCE" – Instance you are connection to.

"DATABASE" – Database connected to.

"USER" – Connected user.

"PASSWORD" – Connected password.

"AUTHENTICATION_MODE" – Credential authentication mode of the connection. Acceptable values are "OSA" and "DBMS".

"VERSION" – Transactional version to connect to. Acceptable value is a string that represents a transaction version name.

"HISTORICAL_NAME" – Historical version to connect to. Acceptable value is a string type that represents a historical marker name.

"HISTORICAL_TIMESTAMP" – Moment in history to establish an historical version connection. Acceptable value is a date time that represents a moment timestamp.

Notes:

• The "DATABASE" property is optional and is required for ArcSDE instances that manage multiple databases (for example, SQL Server).
• If “AUTHENTICATION_MODE” is “OSA” then “USER” and “PASSWORD” are not required. “OSA” represents operating system authentication and uses the operating system credentials to establish a connection with the database.
• Since the workspace connection can only represent one version only 1 of the 3 version properties (“VERSION” or “HISTORICAL_NAME” or “HISTORICAL_TIMESTAMP”) should be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

open in interface IWorkspaceFactory

Parameters:

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openFromFile

public IWorkspace openFromFile(String fileName,
                               int hWnd)
                        throws IOException,
                               AutomationException

Opens the workspace specified by the given file name.

Remarks

OpenFromFile takes the pathname of a file or directory that represents either a FileSystemWorkspace or LocalDatabaseWorkspace, or a connection file to a RemoteDatabase workspace and returns an interface on the specified workspace. Clients of these methods can then proceed to open and access datasets in the workspace. If these methods are called with insufficient properties, then the user will be presented with a connection dialog that will prompt for the required properties.

The hWnd argument is the parent window or application's window. The hWnd will guarantee that the connection dialog, if presented to you because of insufficient properties, has the correct parent.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

openFromFile in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

public IWorkspaceName create(String parentDirectory,
                             String name,
                             IPropertySet connectionProperties,
                             int hWnd)
                      throws IOException,
                             AutomationException

Creates a new workspace specified by the directory, file name, and connection properties.

Remarks

Create has different results depending on the type of workspace factory. If you are working with ArcSDE, a new connection file (.sde) is created. If you are working with an ArcGIS for Desktop Advanced workspace factory, a folder with an INFO subfolder is created. The optional ConnectionProperties parameter specifies any additional connection properties needed, such as the server, instance, user and password in the case where a connection file to a remote database workspace is being created. If no connection properties are specified, this method will result in a dialog being displayed that prompts the user for the required properties.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

create in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

name - The name (in)

connectionProperties - A reference to a com.esri.arcgis.system.IPropertySet (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

containsWorkspace

public boolean containsWorkspace(String parentDirectory,
                                 IFileNames fileNames)
                          throws IOException,
                                 AutomationException

Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace.

Remarks

ContainsWorkspace is useful when browsing the file system for workspaces. It takes a parent directory and the list of file names in the directory to be examined. It returns true if the parent directory represents a workspace covered by this factory or if the parent directory contains a workspace or a connection file to a workspace covered by this factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

containsWorkspace in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

The containsWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceName

public IWorkspaceName getWorkspaceName(String parentDirectory,
                                       IFileNames fileNames)
                                throws IOException,
                                       AutomationException

Retrieves the workspace name of a workspace from the given list of file names.

Remarks

GetWorkspaceName is useful when browsing the file system for workspaces. It is handed in a parent directory and the list of file names in the directory to be examined. It returns a WorkspaceName object representing the first workspace it finds in the list of filenames and removes any filenames representing the workspace from the input list of filenames.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceName in interface IWorkspaceFactory

Parameters:

parentDirectory - The parentDirectory (in)

fileNames - A reference to a com.esri.arcgis.system.IFileNames (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws IOException,
                       AutomationException

The class ID of the WorkspaceFactory.

Remarks

GetClassID returns the unique identifier for the workspace factory. You can use this to distinguish different versions of the same type of factory, for example, whether you are working with an SDEWorkspace, FileGDBWorkspace or AccessWorkspace factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getClassID in interface IWorkspaceFactory

Returns:

A reference to a com.esri.arcgis.system.IUID

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isWorkspace

public boolean isWorkspace(String fileName)
                    throws IOException,
                           AutomationException

True if the specified file identifies a workspace supported by the workspace factory.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

isWorkspace in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

Returns:

The isWorkspace

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

readConnectionPropertiesFromFile

public IPropertySet readConnectionPropertiesFromFile(String fileName)
                                              throws IOException,
                                                     AutomationException

The connection properties from the specified file.

Remarks

The filename parameter represents the pathname of a file that contains the connection information to be placed into the IPropertySet variable.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

readConnectionPropertiesFromFile in interface IWorkspaceFactory

Parameters:

fileName - The fileName (in)

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceDescription

public String getWorkspaceDescription(boolean plural)
                               throws IOException,
                                      AutomationException

A singular or plural description of the type of workspace the workspace factory opens/creates.

Product Availability

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

Specified by:

getWorkspaceDescription in interface IWorkspaceFactory

Parameters:

plural - The plural (in)

Returns:

The description

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWorkspaceType

public int getWorkspaceType()
                     throws IOException,
                            AutomationException

The type of workspace the workspace factory opens/creates.

Remarks

The WorkspaceType property of a WorkspaceFactory returns information on the type of workspace managed by the WorkspaceFactory. Workspaces are classified into the following types specified by the esriWorkspaceType enumeration; FileSystemWorkspace, LocalDatabaseWorkspace, and RemoteDatabaseWorkspace.

See esriWorkspaceType for information on the types of workspaces.

Shapefiles workspaces are examples of FileSystemWorkspace. Personal and File Geodatabases are examples of LocalDatabaseWorkspace. An ArcSDE Geodatabase is an example of a RemoteDatabaseWorkspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

getWorkspaceType in interface IWorkspaceFactory

Returns:

A com.esri.arcgis.geodatabase.esriWorkspaceType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

copy

public boolean copy(IWorkspaceName workspaceName,
                    String destinationFolder,
                    IWorkspaceName[] workspaceNameCopy)
             throws IOException,
                    AutomationException

Copies a workspace to the specified destination folder.

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

copy in interface IWorkspaceFactory

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

destinationFolder - The destinationFolder (in)

workspaceNameCopy - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (out: use single element array)

Returns:

The successfulCopy

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

move

public boolean move(IWorkspaceName workspaceName,
                    String destinationFolder)
             throws IOException,
                    AutomationException

Moves a workspace to the specified destination folder.

Remarks

The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

move in interface IWorkspaceFactory

Parameters:

workspaceName - A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)

destinationFolder - The destinationFolder (in)

Returns:

The successfulMove

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteConnectionFile

public void deleteConnectionFile(String pathName)
                          throws IOException,
                                 AutomationException

Deletes the remote database workspace connection file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

deleteConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

renameConnectionFile

public IWorkspaceName renameConnectionFile(String oldPathName,
                                           String newName)
                                    throws IOException,
                                           AutomationException

Renames the remote database workspace connection file.

Remarks

The oldPathName is the path and connection file name. the newName is the new file name without a path. An error is returned if newName has a fully qualified path.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

renameConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

oldPathName - The oldPathName (in)

newName - The newName (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editConnectionFile

public IWorkspaceName editConnectionFile(String pathName,
                                         int hWnd)
                                  throws IOException,
                                         AutomationException

Edits the properties of a remote database workspace connection file.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

editConnectionFile in interface IRemoteDatabaseWorkspaceFactory

Parameters:

pathName - The pathName (in)

hWnd - The hWnd (A COM typedef) (in)

Returns:

A reference to a com.esri.arcgis.geodatabase.IWorkspaceName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllTrackCounts

public IPropertySet getAllTrackCounts()
                               throws IOException,
                                      AutomationException

Indicates track count for each TemporalFeatureClass under the workspace or workspace factory.

Product Availability

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

Specified by:

getAllTrackCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllMessageRates

public IPropertySet getAllMessageRates()
                                throws IOException,
                                       AutomationException

Indicates message rate for each TemporalFeatureClass under the workspace or workspace factory.

Product Availability

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

Specified by:

getAllMessageRates in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllSampleSizes

public IPropertySet getAllSampleSizes()
                               throws IOException,
                                      AutomationException

Indicates sample size used for calculating message rate for each TemporalFeatureClass under the workspace or workspace factory.

Product Availability

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

Specified by:

getAllSampleSizes in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAllTotalFeatureCounts

public IPropertySet getAllTotalFeatureCounts()
                                      throws IOException,
                                             AutomationException

Indicates the total number of features logged for each TemporalFeatureClass under the workspace or workspace factory.

Product Availability

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

Specified by:

getAllTotalFeatureCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getConnectionStatus

public IPropertySet getConnectionStatus()
                                 throws IOException,
                                        AutomationException

Indicates the connection status of each workspace under the workspace factory

Product Availability

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

Specified by:

getConnectionStatus in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReceivedMessageCounts

public IPropertySet getReceivedMessageCounts()
                                      throws IOException,
                                             AutomationException

Indicates total number of messages received.

Product Availability

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

Specified by:

getReceivedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPulledMessageCounts

public IPropertySet getPulledMessageCounts()
                                    throws IOException,
                                           AutomationException

Indicates total number of messages pulled.

Product Availability

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

Specified by:

getPulledMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDiscardedMessageCounts

public IPropertySet getDiscardedMessageCounts()
                                       throws IOException,
                                              AutomationException

Indicates total number of messages discarded.

Product Availability

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

Specified by:

getDiscardedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCurrentDiscardedMessageCounts

public IPropertySet getCurrentDiscardedMessageCounts()
                                              throws IOException,
                                                     AutomationException

Indicates current number of messages discarded.

Product Availability

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

Specified by:

getCurrentDiscardedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueuedMessageCounts

public IPropertySet getQueuedMessageCounts()
                                    throws IOException,
                                           AutomationException

Indicates total number of messages queued.

Product Availability

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

Specified by:

getQueuedMessageCounts in interface ITemporalWorkspaceStatistics

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAllFeatureCounts

public void resetAllFeatureCounts()
                           throws IOException,
                                  AutomationException

Resets total feature count for each TemporalFeatureClass under the workspace or workspace factory.

Product Availability

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

Specified by:

resetAllFeatureCounts in interface ITemporalWorkspaceStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAllMessageRates

public void resetAllMessageRates()
                          throws IOException,
                                 AutomationException

Resets message rate for each TemporalFeatureClass under the workspace or workspace factory.

Product Availability

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

Specified by:

resetAllMessageRates in interface ITemporalWorkspaceStatistics

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAllSampleSizes

public void setAllSampleSizes(int lSampleSize)
                       throws IOException,
                              AutomationException

Sets sample size for each TemporalFeatureClass under the workspace or workspace factory.

Product Availability

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

Specified by:

setAllSampleSizes in interface ITemporalWorkspaceStatistics

Parameters:

lSampleSize - The lSampleSize (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.