com.esri.arcgis.catalog
Class GxTaskServicesFolder

java.lang.Object
  extended by com.esri.arcgis.catalog.GxTaskServicesFolder
All Implemented Interfaces:
IGxObject, IGxObjectContainer, IGxObjectUI, IGxRemoteContainer, IGxTaskServicesFolder, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class GxTaskServicesFolder
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxObject, IGxObjectUI, IGxObjectContainer, IGxTaskServicesFolder, IGxRemoteContainer

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

Description 'GxTaskServicesFolder of ready-to-use Task Services.' 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.IGxObjectUI
IID, IID7273aa57_e6f9_11d2_9f30_00c04f6bc69e, 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.IGxTaskServicesFolder
IID, IIDcbe68e51_d134_4715_ad3f_c94c80b9ff30, xxDummy
 
Fields inherited from interface com.esri.arcgis.catalog.IGxRemoteContainer
IID, IIDb0277e3e_917d_44f3_8860_d2c5e01ad215, xxDummy
 
Constructor Summary
GxTaskServicesFolder()
          Constructs a GxTaskServicesFolder using ArcGIS Engine.
GxTaskServicesFolder(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxTaskServicesFolder theGxTaskServicesFolder = (GxTaskServicesFolder) 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.
 void deleteChild(IGxObject child)
          Deletes the specified child object.
 void detach()
          Instructs the object to detach itself from its parent and the catalog.
 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.
 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.
 IUID getNewMenu()
          The class ID of the New menu for this object.
 IGxObject getParent()
          The parent of the object.
 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.
 void refresh()
          Updates the object and any children of the object.
 void release()
          Release a GxTaskServicesFolder.
 void setName(java.lang.String rhs1)
          The folder name.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GxTaskServicesFolder

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

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

GxTaskServicesFolder

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

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

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

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.

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.

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 folder name.

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