com.esri.arcgis.catalog
Class GxAGSFolder

java.lang.Object
  com.esri.arcgis.catalog.GxAGSFolder

All Implemented Interfaces:

IGxAGSFolder, IGxObject, IGxObjectContainer, IGxObjectEdit, IGxObjectProperties, IGxObjectUI, IGxObjectWizard, IGxPasteTarget, IGxRemoteConnection, INativeTypeInfo, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxAGSFolder
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectContainer, IGxAGSFolder, INativeTypeInfo, IGxObjectEdit, IGxObjectProperties, IGxObjectUI, IGxObjectWizard, IGxPasteTarget, IGxRemoteConnection

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

Description 'The Esri GxAGSFolder 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.IGxObjectContainer

IID, IID7273aa58_e6f9_11d2_9f30_00c04f6bc69e, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxAGSFolder

IID, IID7274cd39_52ad_4256_b799_4fa053361684, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.INativeTypeInfo

IID, IID906db24a_f0ad_4ca5_871b_5466e54fab80, 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.IGxObjectProperties

IID, IIDd342626e_f9da_11d3_a68d_0008c7d3ae8d, 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.IGxObjectWizard

IID, IIDc6df682d_a28c_476a_924c_44d1194cf78d, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxPasteTarget

IID, IIDbdbbb403_d0b2_11d1_aed9_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.catalog.IGxRemoteConnection

IID, IID3f5c143c_8e15_40c7_8ce8_f67289c6842a, xxDummy

Constructor Summary

GxAGSFolder()
Constructs a GxAGSFolder using ArcGIS Engine.

GxAGSFolder(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxAGSFolder theGxAGSFolder = (GxAGSFolder) obj;

Method Summary

IGxObject	addChild(IGxObject child) Adds a new child and returns a reference to it.
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	canPaste(IEnumName names, boolean[] moveOperation) Indicates if the specified names may be pasted into this object.
boolean	canRename() Indicates if the object can be renamed.
void	connect() Connects to a remote data source.
void	delete() Deletes the object.
void	deleteChild(IGxObject child) Deletes the specified child object.
void	detach() Instructs the object to detach itself from its parent and the catalog.
void	disconnect() Disconnects to a remote data source.
void	editFolderProperties(int hParent) Edit the folder properties.
void	editProperties(int hParent) Presents a modal dialog to allow editing the object's properties.
boolean	equals(java.lang.Object o) Compare this object with another
IAGSServerConnection	getAGSServerConnection() The AGS server connection.
IAGSServerConnectionName	getAGSServerConnectionName() The AGS server connection name.
java.lang.String	getBaseName() The base name of the object (i.e.
java.lang.String	getCategory() The category of the object.
IEnumGxObject	getChildren() An enumeration of the child objects.
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.
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.
java.lang.String	getName() The short name of the object.
INativeType	getNativeType() The native type.
IUID	getNewMenu() The class ID of the New menu for this object.
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.
java.lang.Object	getSelectedServerObjects() The selected server objects.
int	getSmallImage() The small image that represents the object.
int	getSmallSelectedImage() The small image that represents the object when it is selected.
int	hashCode() the hashcode for this object
boolean	isAreChildrenViewable() Indicates if the objects children are available for viewing in the tree-view.
boolean	isHasChildren() Indicates if the object has any children.
boolean	isValid() Indicates if the object is still valid.
boolean	paste(IEnumName names, boolean[] moveOperation) Pastes the specified names into this object.
void	refresh() Updates the object and any children of the object.
void	release() Release a GxAGSFolder.
void	rename(java.lang.String newShortName) Renames the object.
void	setAGSServerConnectionByRef(IAGSServerConnection conn) The AGS server connection.
void	setAGSServerConnectionNameByRef(IAGSServerConnectionName connName) The AGS server connection name.
void	setName(java.lang.String rhs1) The AGS folder name.
void	setProperty(java.lang.String name, java.lang.Object value) Set the value of the named property in the GxObject.
void	setSelectedServerObjects(java.lang.Object selectedObjects) The selected server objects.

Methods inherited from class java.lang.Object

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

Constructor Detail

GxAGSFolder

public GxAGSFolder()
            throws java.io.IOException,
                   java.net.UnknownHostException

Constructs a GxAGSFolder using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxAGSFolder

public GxAGSFolder(java.lang.Object obj)
            throws java.io.IOException

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

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

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 GxAGSFolder.

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.

isHasChildren

public boolean isHasChildren()
                      throws java.io.IOException,
                             AutomationException

Indicates if the object has any children.

Specified by:

isHasChildren in interface IGxObjectContainer

Returns:

The hasChildren

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getChildren

public IEnumGxObject getChildren()
                          throws java.io.IOException,
                                 AutomationException

An enumeration of the child objects.

Specified by:

getChildren in interface IGxObjectContainer

Returns:

A reference to a com.esri.arcgis.catalog.IEnumGxObject

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isAreChildrenViewable

public boolean isAreChildrenViewable()
                              throws java.io.IOException,
                                     AutomationException

Indicates if the objects children are available for viewing in the tree-view.

Specified by:

isAreChildrenViewable in interface IGxObjectContainer

Returns:

The areViewable

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addChild

public IGxObject addChild(IGxObject child)
                   throws java.io.IOException,
                          AutomationException

Adds a new child and returns a reference to it. However, if a duplicate already exists, the function returns the existing child instead.

Specified by:

addChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (in)

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.

deleteChild

public void deleteChild(IGxObject child)
                 throws java.io.IOException,
                        AutomationException

Deletes the specified child object.

Specified by:

deleteChild in interface IGxObjectContainer

Parameters:

child - A reference to a com.esri.arcgis.catalog.IGxObject (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String rhs1)
             throws java.io.IOException,
                    AutomationException

The AGS folder name.

Specified by:

setName in interface IGxAGSFolder

Parameters:

rhs1 - The rhs1 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAGSServerConnectionByRef

public void setAGSServerConnectionByRef(IAGSServerConnection conn)
                                 throws java.io.IOException,
                                        AutomationException

The AGS server connection.

Specified by:

setAGSServerConnectionByRef in interface IGxAGSFolder

Parameters:

conn - A reference to a com.esri.arcgis.gisclient.IAGSServerConnection (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGSServerConnection

public IAGSServerConnection getAGSServerConnection()
                                            throws java.io.IOException,
                                                   AutomationException

The AGS server connection.

Specified by:

getAGSServerConnection in interface IGxAGSFolder

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAGSServerConnectionName

public IAGSServerConnectionName getAGSServerConnectionName()
                                                    throws java.io.IOException,
                                                           AutomationException

The AGS server connection name.

Specified by:

getAGSServerConnectionName in interface IGxAGSFolder

Returns:

A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setAGSServerConnectionNameByRef

public void setAGSServerConnectionNameByRef(IAGSServerConnectionName connName)
                                     throws java.io.IOException,
                                            AutomationException

The AGS server connection name.

Specified by:

setAGSServerConnectionNameByRef in interface IGxAGSFolder

Parameters:

connName - A reference to a com.esri.arcgis.gisclient.IAGSServerConnectionName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

editFolderProperties

public void editFolderProperties(int hParent)
                          throws java.io.IOException,
                                 AutomationException

Edit the folder properties.

Specified by:

editFolderProperties in interface IGxAGSFolder

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.

getSelectedServerObjects

public java.lang.Object getSelectedServerObjects()
                                          throws java.io.IOException,
                                                 AutomationException

The selected server objects.

Specified by:

getSelectedServerObjects in interface IGxAGSFolder

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectedServerObjects

public void setSelectedServerObjects(java.lang.Object selectedObjects)
                              throws java.io.IOException,
                                     AutomationException

The selected server objects.

Specified by:

setSelectedServerObjects in interface IGxAGSFolder

Parameters:

selectedObjects - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getNativeType

public INativeType getNativeType()
                          throws java.io.IOException,
                                 AutomationException

The native type.

Specified by:

getNativeType in interface INativeTypeInfo

Returns:

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

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.

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.

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.

canPaste

public boolean canPaste(IEnumName names,
                        boolean[] moveOperation)
                 throws java.io.IOException,
                        AutomationException

Indicates if the specified names may be pasted into this object. On output, moveOperation indicates if a subsequent paste operation would represent a move, or merely a copy, operation.

Specified by:

canPaste in interface IGxPasteTarget

Parameters:

names - A reference to a com.esri.arcgis.system.IEnumName (in)

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The canPaste

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

paste

public boolean paste(IEnumName names,
                     boolean[] moveOperation)
              throws java.io.IOException,
                     AutomationException

Pastes the specified names into this object. On input, moveOperation indicates if this is a move operation. On output, it indicates if the objects have been moved, or merely copied.

Specified by:

paste in interface IGxPasteTarget

Parameters:

names - A reference to a com.esri.arcgis.system.IEnumName (in)

moveOperation - The moveOperation (in/out: use single element array)

Returns:

The successfulPaste

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

connect

public void connect()
             throws java.io.IOException,
                    AutomationException

Connects to a remote data source.

Specified by:

connect in interface IGxRemoteConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

disconnect

public void disconnect()
                throws java.io.IOException,
                       AutomationException

Disconnects to a remote data source.

Specified by:

disconnect in interface IGxRemoteConnection

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.