com.esri.arcgis.trackinganalyst
Class TxFolderCatalogObject

java.lang.Object
  extended by com.esri.arcgis.trackinganalyst.TxFolderCatalogObject
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, ITxCatalogObject, ITxFolderObject, ITxObjectContainer, ITxObjectProperties, ITxObjectPropertiesGEN, java.io.Serializable

public class TxFolderCatalogObject
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITxFolderObject, ITxCatalogObject, ITxObjectContainer, ITxObjectProperties, ITxObjectPropertiesGEN, ISupportErrorInfo

COM Class 'TxFolderCatalogObject'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'The TxFolderCatalogObject provides a container for CJMTK Catalog Objects much like a directory folder does to a filesystem.' 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.trackinganalyst.ITxFolderObject
IID, IID71113a88_88ed_11d7_b87c_00010265adc5, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxCatalogObject
IID, IID71113a80_88ed_11d7_b87c_00010265adc5, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxObjectContainer
IID, IID71113a82_88ed_11d7_b87c_00010265adc5, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxObjectProperties
IID, IID71113a81_88ed_11d7_b87c_00010265adc5, xxDummy
 
Fields inherited from interface com.esri.arcgis.trackinganalyst.ITxObjectPropertiesGEN
IID, IIDd9feff53_be6b_4734_9b73_1337f3d37643, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo
IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy
 
Constructor Summary
TxFolderCatalogObject()
          Constructs a TxFolderCatalogObject using ArcGIS Engine.
TxFolderCatalogObject(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TxFolderCatalogObject theTxFolderCatalogObject = (TxFolderCatalogObject) obj;
 
Method Summary
 ITxCatalogObject addChild(ITxCatalogObject child)
          Adds a new child and returns a reference to it.
 void attach(ITxCatalogObject parent, ITxCatalog pCatalog)
          Attaches the object to its parent and the catalog.
 void deleteChild(ITxCatalogObject child)
          Deletes the specified child object.
 void detach()
          Instructs the object to detach itself from its parent and the catalog.
 void empty()
          Empty the container.
 boolean equals(java.lang.Object o)
          Compare this object with another
 java.lang.String getBaseName()
          The base name of the object (i.e.
 java.lang.String getCategory()
          The category of the object.
 IEnumTxObject getChildren()
          An enumeration of the child objects.
 IUID getClassID()
          The class ID of this object.
static java.lang.String getClsid()
          getClsid.
 int getCount()
          The number of Objects in the container.
 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.
 java.lang.String getName()
          The short name of the object.
 ITxCatalogObject getParent()
          The parent of the object.
 java.lang.String getPath()
          Folder objects path on disk.
 int getSmallImage()
          The small image that represents the object.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isAreChildrenViewable()
          Indicates if the objects children are available for viewing in the tree-view.
 boolean isHasChildren()
          Indicates if the catalog object have any children.
 boolean isValid()
          Indicates if the object is still valid.
 void refresh()
          Updates the object and any children of the object.
 void release()
          Release a TxFolderCatalogObject.
 void setPath(java.lang.String pbstrCurrentPath)
          Folder objects path on disk.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TxFolderCatalogObject

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

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

TxFolderCatalogObject

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

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

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

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

getPath

public java.lang.String getPath()
                         throws java.io.IOException,
                                AutomationException
Folder objects path on disk.

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

setPath

public void setPath(java.lang.String pbstrCurrentPath)
             throws java.io.IOException,
                    AutomationException
Folder objects path on disk.

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

getName

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

Specified by:
getName in interface ITxCatalogObject
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 ITxCatalogObject
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 ITxCatalogObject
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 ITxCatalogObject
Returns:
The category
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getParent

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

Specified by:
getParent in interface ITxCatalogObject
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject
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 ITxCatalogObject
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 ITxCatalogObject
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 ITxCatalogObject
Returns:
The isValid
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

attach

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

Specified by:
attach in interface ITxCatalogObject
Parameters:
parent - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject (in)
pCatalog - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalog (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 ITxCatalogObject
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 ITxCatalogObject
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 catalog object have any children.

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

getChildren

public IEnumTxObject getChildren()
                          throws java.io.IOException,
                                 AutomationException
An enumeration of the child objects.

Specified by:
getChildren in interface ITxObjectContainer
Returns:
A reference to a com.esri.arcgis.trackinganalyst.IEnumTxObject
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 ITxObjectContainer
Returns:
The areViewable
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addChild

public ITxCatalogObject addChild(ITxCatalogObject 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 ITxObjectContainer
Parameters:
child - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject (in)
Returns:
A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteChild

public void deleteChild(ITxCatalogObject child)
                 throws java.io.IOException,
                        AutomationException
Deletes the specified child object.

Specified by:
deleteChild in interface ITxObjectContainer
Parameters:
child - A reference to a com.esri.arcgis.trackinganalyst.ITxCatalogObject (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws java.io.IOException,
                    AutomationException
The number of Objects in the container.

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

empty

public void empty()
           throws java.io.IOException,
                  AutomationException
Empty the container.

Specified by:
empty in interface ITxObjectContainer
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 ITxObjectProperties
Specified by:
getSmallImage in interface ITxObjectPropertiesGEN
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 ITxObjectProperties
Specified by:
getLargeImage in interface ITxObjectPropertiesGEN
Returns:
The hBitmap (A COM typedef)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException
interfaceSupportsErrorInfo

Specified by:
interfaceSupportsErrorInfo in interface ISupportErrorInfo
Parameters:
riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.