com.esri.arcgis.datainterop
Class DatasourceUtilUI

java.lang.Object
  com.esri.arcgis.datainterop.DatasourceUtilUI

All Implemented Interfaces:

IDatasourceUtilUI, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class DatasourceUtilUI
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IDatasourceUtilUI

DatasourceUtilUI Class

Product Availability

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

See Also:

Serialized Form

Constructor Summary

DatasourceUtilUI()
Constructs a DatasourceUtilUI using ArcGIS Engine.

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

Method Summary

void	dialogWithHelp(String title, String message, String dismissLabel, String helpLabel, String helpFile, String helpTopic) method DialogWithHelp
void	dialogWithHelpUsingResources(int title, int message, String helpFile, String helpTopic) method DialogWithHelpUsingResources
boolean	equals(Object o) Compare this object with another
void	extensionNotEnabledDialog(boolean showUnconditionally) method ExtensionNotEnabledDialog
void	extensionShutdown() method ExtensionShutdown
void	extensionStartup(Object initializationData) method ExtensionStartup
String	getApplicationName() property ApplicationName
static String	getClsid() getClsid.
int	hashCode() the hashcode for this object
boolean	isApplication() property IsApplication
boolean	isArcCatalog() property IsArcCatalog
void	messageDialog(String title, String message, String dismissLabel) method MessageDialog
void	messageDialogUsingResources(int title, int message) method MessageDialogUsingResources
void	messageStatus(String message) method MessageStatus
void	progressCreate(String title, String description) method ProgressCreate
void	progressDestroy() method ProgressDestroy
void	progressQuery(boolean[] keepGoing) method ProgressQuery
void	progressUpdate(String message) method ProgressUpdate
void	resetAllDatasets() method ResetAllDatasets
void	setDialogsPermitted(boolean rhs1) property DialogsPermitted
void	setRootObjectVisibility(boolean showRoot) method SetRootObjectVisibility

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

DatasourceUtilUI

public DatasourceUtilUI()
                 throws IOException,
                        UnknownHostException

Constructs a DatasourceUtilUI using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

DatasourceUtilUI

public DatasourceUtilUI(Object obj)
                 throws IOException

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

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

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

extensionStartup

public void extensionStartup(Object initializationData)
                      throws IOException,
                             AutomationException

method ExtensionStartup

Product Availability

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

Specified by:

extensionStartup in interface IDatasourceUtilUI

Parameters:

initializationData - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

extensionShutdown

public void extensionShutdown()
                       throws IOException,
                              AutomationException

method ExtensionShutdown

Product Availability

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

Specified by:

extensionShutdown in interface IDatasourceUtilUI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplication

public boolean isApplication()
                      throws IOException,
                             AutomationException

property IsApplication

Product Availability

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

Specified by:

isApplication in interface IDatasourceUtilUI

Returns:

The isApp

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isArcCatalog

public boolean isArcCatalog()
                     throws IOException,
                            AutomationException

property IsArcCatalog

Product Availability

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

Specified by:

isArcCatalog in interface IDatasourceUtilUI

Returns:

The isArcCat

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getApplicationName

public String getApplicationName()
                          throws IOException,
                                 AutomationException

property ApplicationName

Product Availability

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

Specified by:

getApplicationName in interface IDatasourceUtilUI

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDialogsPermitted

public void setDialogsPermitted(boolean rhs1)
                         throws IOException,
                                AutomationException

property DialogsPermitted

Product Availability

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

Specified by:

setDialogsPermitted in interface IDatasourceUtilUI

Parameters:

rhs1 - The rhs1 (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

extensionNotEnabledDialog

public void extensionNotEnabledDialog(boolean showUnconditionally)
                               throws IOException,
                                      AutomationException

method ExtensionNotEnabledDialog

Product Availability

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

Specified by:

extensionNotEnabledDialog in interface IDatasourceUtilUI

Parameters:

showUnconditionally - The showUnconditionally (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

resetAllDatasets

public void resetAllDatasets()
                      throws IOException,
                             AutomationException

method ResetAllDatasets

Product Availability

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

Specified by:

resetAllDatasets in interface IDatasourceUtilUI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRootObjectVisibility

public void setRootObjectVisibility(boolean showRoot)
                             throws IOException,
                                    AutomationException

method SetRootObjectVisibility

Product Availability

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

Specified by:

setRootObjectVisibility in interface IDatasourceUtilUI

Parameters:

showRoot - The showRoot (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dialogWithHelpUsingResources

public void dialogWithHelpUsingResources(int title,
                                         int message,
                                         String helpFile,
                                         String helpTopic)
                                  throws IOException,
                                         AutomationException

method DialogWithHelpUsingResources

Product Availability

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

Specified by:

dialogWithHelpUsingResources in interface IDatasourceUtilUI

Parameters:

title - The title (in)

message - The message (in)

helpFile - The helpFile (in)

helpTopic - The helpTopic (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

dialogWithHelp

public void dialogWithHelp(String title,
                           String message,
                           String dismissLabel,
                           String helpLabel,
                           String helpFile,
                           String helpTopic)
                    throws IOException,
                           AutomationException

method DialogWithHelp

Product Availability

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

Specified by:

dialogWithHelp in interface IDatasourceUtilUI

Parameters:

title - The title (in)

message - The message (in)

dismissLabel - The dismissLabel (in)

helpLabel - The helpLabel (in)

helpFile - The helpFile (in)

helpTopic - The helpTopic (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

messageDialogUsingResources

public void messageDialogUsingResources(int title,
                                        int message)
                                 throws IOException,
                                        AutomationException

method MessageDialogUsingResources

Product Availability

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

Specified by:

messageDialogUsingResources in interface IDatasourceUtilUI

Parameters:

title - The title (in)

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

messageDialog

public void messageDialog(String title,
                          String message,
                          String dismissLabel)
                   throws IOException,
                          AutomationException

method MessageDialog

Product Availability

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

Specified by:

messageDialog in interface IDatasourceUtilUI

Parameters:

title - The title (in)

message - The message (in)

dismissLabel - The dismissLabel (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

messageStatus

public void messageStatus(String message)
                   throws IOException,
                          AutomationException

method MessageStatus

Product Availability

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

Specified by:

messageStatus in interface IDatasourceUtilUI

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

progressCreate

public void progressCreate(String title,
                           String description)
                    throws IOException,
                           AutomationException

method ProgressCreate

Product Availability

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

Specified by:

progressCreate in interface IDatasourceUtilUI

Parameters:

title - The title (in)

description - The description (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

progressUpdate

public void progressUpdate(String message)
                    throws IOException,
                           AutomationException

method ProgressUpdate

Product Availability

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

Specified by:

progressUpdate in interface IDatasourceUtilUI

Parameters:

message - The message (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

progressQuery

public void progressQuery(boolean[] keepGoing)
                   throws IOException,
                          AutomationException

method ProgressQuery

Product Availability

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

Specified by:

progressQuery in interface IDatasourceUtilUI

Parameters:

keepGoing - The keepGoing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

progressDestroy

public void progressDestroy()
                     throws IOException,
                            AutomationException

method ProgressDestroy

Product Availability

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

Specified by:

progressDestroy in interface IDatasourceUtilUI

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.