com.esri.arcgis.catalog
Class GxAGSCatalog

java.lang.Object
  extended by com.esri.arcgis.catalog.GxAGSCatalog
All Implemented Interfaces:
IGxAGSCatalog, IGxAGSObject, IGxAGSObject2, IGxAGSObject3, IGxItemInfo, IGxObject, IGxObjectEdit, IGxObjectProperties, IGxObjectUI, IGxThumbnail, IMetadata, IMetadataEdit, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxAGSCatalog
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectEdit, IGxObjectUI, IGxObjectProperties, IGxAGSObject, IGxAGSObject2, IGxAGSObject3, IGxItemInfo, IGxAGSCatalog, IGxThumbnail, IMetadata, IMetadataEdit

COM Class 'GxAGSCatalog'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'GxObject that represents an ArcGIS Server data sharing object.' 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 =

See Also:
Serialized Form

Field Summary
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObject
IID, IIDbdbbb3eb_d0b2_11d1_aed9_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectEdit
IID, IIDbdbbb3fc_d0b2_11d1_aed9_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectUI
IID, IID7273aa57_e6f9_11d2_9f30_00c04f6bc69e, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxObjectProperties
IID, IIDd342626e_f9da_11d3_a68d_0008c7d3ae8d, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxAGSObject3
IID, IIDd7c32b7f_28a8_4a7c_8c8a_333dfa49696a, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxAGSObject2
IIDd4887d25_38e9_461e_9e37_731cc4934d1a
 
Fields inherited from interface com.esri.arcgis.catalog.IGxAGSObject
IID04429be9_3a92_4327_9f49_9ee30b95fb3c
 
Fields inherited from interface com.esri.arcgis.catalog.IGxItemInfo
IID, IID5ebc0f34_e575_4f40_a36b_f7e3896ac9a2, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxAGSCatalog
IID, IIDdc95f566_575d_43c4_b0b3_0267cc7cc9df, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxThumbnail
IID, IIDda1862ed_95f8_11d2_af67_080009ec734b, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadata
IID, IID5de04a82_24e4_11d3_a641_0008c7d3ae50, xxDummy
 
Fields inherited from interface com.esri.arcgis.geodatabase.IMetadataEdit
IID, IID97fdb978_62a4_49c5_8252_b07837b33ee9, xxDummy
 
Constructor Summary
GxAGSCatalog()
          Constructs a GxAGSCatalog using ArcGIS Engine.
GxAGSCatalog(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxAGSCatalog theGxAGSCatalog = (GxAGSCatalog) obj;
 
Method Summary
 void attach(IGxObject parent, IGxCatalog pCatalog)
          Attaches the object to its parent and the catalog.
 boolean canCopy()
          Indicates if the object can be copied.
 boolean canDelete()
          Indicates if the object can be deleted.
 boolean canRename()
          Indicates if the object can be renamed.
 void delete()
          Deletes the object.
 void detach()
          Instructs the object to detach itself from its parent and the catalog.
 void editProperties(int hParent)
          Presents a modal dialog to allow editing the object's properties.
 void editServerObjectProperties(int hParent)
          Presents a modal dialog to allow editing the properties of the server object.
 boolean equals(java.lang.Object o)
          Compare this object with another
 IAGSServerObjectName getAGSServerObjectName()
          The associated AGS server object name.
 java.lang.String getBaseName()
          The base name of the object (i.e.
 java.lang.String getCategory()
          The category of the object.
 IUID getClassID()
          The class ID of this object.
static java.lang.String getClsid()
          getClsid.
 IUID getContextMenu()
          The class ID of the context menu for this object.
 java.lang.String getFullName()
          The full name of the object.
 IName getInternalObjectName()
          The Name for the internal object that this GxObject represents.
 IItemInfo getItemInfo()
          The ItemInfo of the service.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 int getLargeImage()
          The large image that represents the object.
 int getLargeSelectedImage()
          The large image that represents the object when it is selected.
 IPropertySet getMetadata()
          The PropertySet containing metadata.
 java.lang.String getName()
          The short name of the object.
 IUID getNewMenu()
          The class ID of the New menu for this object.
 int getNumInstancesInUse()
          The number of instances in use.
 int getNumInstancesRunning()
          The number of instances running.
 IGxObject getParent()
          The parent of the object.
 void getPropByIndex(int index, java.lang.String[] name, java.lang.Object[] value)
          The name and value of the indexed property in the GxObject.
 java.lang.Object getProperty(java.lang.String name)
          The value of the named property in the GxObject.
 int getPropertyCount()
          The number of properties in the GxObject.
 IServerObjectConfiguration getServerObjectConfiguration()
          Server Object Configuration.
 java.lang.String getServerObjectType()
          Name of Server Object Type.
 int getSmallImage()
          The small image that represents the object.
 int getSmallSelectedImage()
          The small image that represents the object when it is selected.
 java.lang.String getStatus()
          The status of the server object.
 IPicture getThumbnail()
          The Thumbnail.
 int hashCode()
          the hashcode for this object
 boolean isCanEditItemInfo()
          Indicates whether the ItemInfo is editable.
 boolean isCanEditMetadata()
          Indicates if metadata can be edited.
 boolean isValid()
          Indicates if the object is still valid.
 void refresh()
          Updates the object and any children of the object.
 void release()
          Release a GxAGSCatalog.
 void rename(java.lang.String newShortName)
          Renames the object.
 void setAGSServerObjectNameByRef(IAGSServerObjectName agsObjectName)
          The associated AGS server object name.
 void setItemInfo(IItemInfo ppItemInfo)
          The ItemInfo of the service.
 void setMetadata(IPropertySet propertySet)
          The PropertySet containing metadata.
 void setProperty(java.lang.String name, java.lang.Object value)
          Set the value of the named property in the GxObject.
 void setThumbnailByRef(IPicture picture)
          The Thumbnail.
 void synchronize(int action, int interval)
          Updates metadata with the current properties; may create metadata if it doesn't already exist.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GxAGSCatalog

public GxAGSCatalog()
             throws java.io.IOException,
                    java.net.UnknownHostException
Constructs a GxAGSCatalog using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

GxAGSCatalog

public GxAGSCatalog(java.lang.Object obj)
             throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxAGSCatalog theGxAGSCatalog = (GxAGSCatalog) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a GxAGSCatalog.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
The short name of the object.

Specified by:
getName in interface IGxObject
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFullName

public java.lang.String getFullName()
                             throws java.io.IOException,
                                    AutomationException
The full name of the object.

Specified by:
getFullName in interface IGxObject
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBaseName

public java.lang.String getBaseName()
                             throws java.io.IOException,
                                    AutomationException
The base name of the object (i.e. no extension).

Specified by:
getBaseName in interface IGxObject
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

public java.lang.String getCategory()
                             throws java.io.IOException,
                                    AutomationException
The category of the object.

Specified by:
getCategory in interface IGxObject
Returns:
The category
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

public IGxObject getParent()
                    throws java.io.IOException,
                           AutomationException
The parent of the object.

Specified by:
getParent in interface IGxObject
Returns:
A reference to a com.esri.arcgis.catalog.IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public IUID getClassID()
                throws java.io.IOException,
                       AutomationException
The class ID of this object.

Specified by:
getClassID in interface IGxObject
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getInternalObjectName

public IName getInternalObjectName()
                            throws java.io.IOException,
                                   AutomationException
The Name for the internal object that this GxObject represents.

Specified by:
getInternalObjectName in interface IGxObject
Returns:
A reference to a com.esri.arcgis.system.IName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isValid

public boolean isValid()
                throws java.io.IOException,
                       AutomationException
Indicates if the object is still valid.

Specified by:
isValid in interface IGxObject
Returns:
The isValid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attach

public void attach(IGxObject parent,
                   IGxCatalog pCatalog)
            throws java.io.IOException,
                   AutomationException
Attaches the object to its parent and the catalog.

Specified by:
attach in interface IGxObject
Parameters:
parent - A reference to a com.esri.arcgis.catalog.IGxObject (in)
pCatalog - A reference to a com.esri.arcgis.catalog.IGxCatalog (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

detach

public void detach()
            throws java.io.IOException,
                   AutomationException
Instructs the object to detach itself from its parent and the catalog.

Specified by:
detach in interface IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

refresh

public void refresh()
             throws java.io.IOException,
                    AutomationException
Updates the object and any children of the object.

Specified by:
refresh in interface IGxObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canRename

public boolean canRename()
                  throws java.io.IOException,
                         AutomationException
Indicates if the object can be renamed.

Specified by:
canRename in interface IGxObjectEdit
Returns:
The canRename
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

rename

public void rename(java.lang.String newShortName)
            throws java.io.IOException,
                   AutomationException
Renames the object.

Specified by:
rename in interface IGxObjectEdit
Parameters:
newShortName - The newShortName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canDelete

public boolean canDelete()
                  throws java.io.IOException,
                         AutomationException
Indicates if the object can be deleted.

Specified by:
canDelete in interface IGxObjectEdit
Returns:
The canDelete
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

delete

public void delete()
            throws java.io.IOException,
                   AutomationException
Deletes the object.

Specified by:
delete in interface IGxObjectEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

editProperties

public void editProperties(int hParent)
                    throws java.io.IOException,
                           AutomationException
Presents a modal dialog to allow editing the object's properties.

Specified by:
editProperties in interface IGxObjectEdit
Parameters:
hParent - The hParent (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

canCopy

public boolean canCopy()
                throws java.io.IOException,
                       AutomationException
Indicates if the object can be copied.

Specified by:
canCopy in interface IGxObjectEdit
Returns:
The canCopy
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallImage

public int getSmallImage()
                  throws java.io.IOException,
                         AutomationException
The small image that represents the object.

Specified by:
getSmallImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSmallSelectedImage

public int getSmallSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
The small image that represents the object when it is selected.

Specified by:
getSmallSelectedImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeImage

public int getLargeImage()
                  throws java.io.IOException,
                         AutomationException
The large image that represents the object.

Specified by:
getLargeImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLargeSelectedImage

public int getLargeSelectedImage()
                          throws java.io.IOException,
                                 AutomationException
The large image that represents the object when it is selected.

Specified by:
getLargeSelectedImage in interface IGxObjectUI
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getContextMenu

public IUID getContextMenu()
                    throws java.io.IOException,
                           AutomationException
The class ID of the context menu for this object.

Specified by:
getContextMenu in interface IGxObjectUI
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNewMenu

public IUID getNewMenu()
                throws java.io.IOException,
                       AutomationException
The class ID of the New menu for this object.

Specified by:
getNewMenu in interface IGxObjectUI
Returns:
A reference to a com.esri.arcgis.system.IUID
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropertyCount

public int getPropertyCount()
                     throws java.io.IOException,
                            AutomationException
The number of properties in the GxObject.

Specified by:
getPropertyCount in interface IGxObjectProperties
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPropByIndex

public void getPropByIndex(int index,
                           java.lang.String[] name,
                           java.lang.Object[] value)
                    throws java.io.IOException,
                           AutomationException
The name and value of the indexed property in the GxObject.

Specified by:
getPropByIndex in interface IGxObjectProperties
Parameters:
index - The index (in)
name - The name (in/out: use single element array)
value - A Variant (in/out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getProperty

public java.lang.Object getProperty(java.lang.String name)
                             throws java.io.IOException,
                                    AutomationException
The value of the named property in the GxObject.

Specified by:
getProperty in interface IGxObjectProperties
Parameters:
name - The name (in)
Returns:
A Variant
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
                 throws java.io.IOException,
                        AutomationException
Set the value of the named property in the GxObject.

Specified by:
setProperty in interface IGxObjectProperties
Parameters:
name - The name (in)
value - A Variant (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getAGSServerObjectName

public IAGSServerObjectName getAGSServerObjectName()
                                            throws java.io.IOException,
                                                   AutomationException
The associated AGS server object name.

Specified by:
getAGSServerObjectName in interface IGxAGSObject
Returns:
A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setAGSServerObjectNameByRef

public void setAGSServerObjectNameByRef(IAGSServerObjectName agsObjectName)
                                 throws java.io.IOException,
                                        AutomationException
The associated AGS server object name.

Specified by:
setAGSServerObjectNameByRef in interface IGxAGSObject
Parameters:
agsObjectName - A reference to a com.esri.arcgis.gisclient.IAGSServerObjectName (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

editServerObjectProperties

public void editServerObjectProperties(int hParent)
                                throws java.io.IOException,
                                       AutomationException
Presents a modal dialog to allow editing the properties of the server object.

Specified by:
editServerObjectProperties in interface IGxAGSObject
Parameters:
hParent - The hParent (A COM typedef) (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getStatus

public java.lang.String getStatus()
                           throws java.io.IOException,
                                  AutomationException
The status of the server object.

Specified by:
getStatus in interface IGxAGSObject
Returns:
The status
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumInstancesRunning

public int getNumInstancesRunning()
                           throws java.io.IOException,
                                  AutomationException
The number of instances running.

Specified by:
getNumInstancesRunning in interface IGxAGSObject
Returns:
The number
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getNumInstancesInUse

public int getNumInstancesInUse()
                         throws java.io.IOException,
                                AutomationException
The number of instances in use.

Specified by:
getNumInstancesInUse in interface IGxAGSObject
Returns:
The number
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerObjectType

public java.lang.String getServerObjectType()
                                     throws java.io.IOException,
                                            AutomationException
Name of Server Object Type.

Specified by:
getServerObjectType in interface IGxAGSObject2
Returns:
The serverObjectType
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getServerObjectConfiguration

public IServerObjectConfiguration getServerObjectConfiguration()
                                                        throws java.io.IOException,
                                                               AutomationException
Server Object Configuration.

Specified by:
getServerObjectConfiguration in interface IGxAGSObject3
Returns:
A reference to a com.esri.arcgis.server.IServerObjectConfiguration
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getItemInfo

public IItemInfo getItemInfo()
                      throws java.io.IOException,
                             AutomationException
The ItemInfo of the service.

Specified by:
getItemInfo in interface IGxItemInfo
Returns:
A reference to a com.esri.arcgis.geodatabase.IItemInfo
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setItemInfo

public void setItemInfo(IItemInfo ppItemInfo)
                 throws java.io.IOException,
                        AutomationException
The ItemInfo of the service.

Specified by:
setItemInfo in interface IGxItemInfo
Parameters:
ppItemInfo - A reference to a com.esri.arcgis.geodatabase.IItemInfo (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditItemInfo

public boolean isCanEditItemInfo()
                          throws java.io.IOException,
                                 AutomationException
Indicates whether the ItemInfo is editable.

Specified by:
isCanEditItemInfo in interface IGxItemInfo
Returns:
The pEditable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setThumbnailByRef

public void setThumbnailByRef(IPicture picture)
                       throws java.io.IOException,
                              AutomationException
The Thumbnail.

Specified by:
setThumbnailByRef in interface IGxThumbnail
Parameters:
picture - A reference to a com.esri.arcgis.support.ms.stdole.IPicture (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getThumbnail

public IPicture getThumbnail()
                      throws java.io.IOException,
                             AutomationException
The Thumbnail.

Specified by:
getThumbnail in interface IGxThumbnail
Returns:
A reference to a com.esri.arcgis.support.ms.stdole.IPicture
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMetadata

public IPropertySet getMetadata()
                         throws java.io.IOException,
                                AutomationException
The PropertySet containing metadata.

Specified by:
getMetadata in interface IMetadata
Returns:
A reference to a com.esri.arcgis.system.IPropertySet
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMetadata

public void setMetadata(IPropertySet propertySet)
                 throws java.io.IOException,
                        AutomationException
The PropertySet containing metadata.

Specified by:
setMetadata in interface IMetadata
Parameters:
propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

synchronize

public void synchronize(int action,
                        int interval)
                 throws java.io.IOException,
                        AutomationException
Updates metadata with the current properties; may create metadata if it doesn't already exist.

Specified by:
synchronize in interface IMetadata
Parameters:
action - A com.esri.arcgis.geodatabase.esriMetadataSyncAction constant (in)
interval - The interval (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isCanEditMetadata

public boolean isCanEditMetadata()
                          throws java.io.IOException,
                                 AutomationException
Indicates if metadata can be edited.

Specified by:
isCanEditMetadata in interface IMetadataEdit
Returns:
The canEdit
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.