com.esri.arcgis.datasourcesraster

Class ItemPathsOptions

java.lang.Object

com.esri.arcgis.datasourcesraster.ItemPathsOptions

All Implemented Interfaces:

IItemPathsOptions, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, java.io.Serializable

public class ItemPathsOptions
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IItemPathsOptions, IDocumentVersionSupportGEN

COM Class 'ItemPathsOptions'. Generated 9/24/2024 11:01:26 AM from 'X:\ArcGIS\com\server\esriDataSourcesRaster.tlb'

Description 'Parameters that indicate path query and replacement options.' 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.datasourcesraster.IItemPathsOptions

IID, IID03ab09fc_cc80_4f8b_b09c_e0ac241e5912, xxDummy

Constructor Summary

Constructors

Constructor and Description
ItemPathsOptions() Constructs a ItemPathsOptions using ArcGIS Engine.
ItemPathsOptions(java.lang.Object obj) Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ItemPathsOptions theItemPathsOptions = (ItemPathsOptions) obj;

Method Summary

Modifier and Type	Method and Description
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.
int	hashCode() the hashcode for this object
boolean	isBrokenPathsOnly() Indicates whether only broken paths are returned.
boolean	isFoldersOnly() Indicates whether only folder paths are returned.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	release() Release this COM object reference
void	setBrokenPathsOnly(boolean pbBrokenOnly) Indicates whether only broken paths are returned.
void	setFoldersOnly(boolean pbFoldersOnly) Indicates whether only folder paths are returned.

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemPathsOptions

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

Constructs a ItemPathsOptions using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ItemPathsOptions

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

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

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

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()

Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this interface indicates the implementing class references.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

Returns:

the COM object reference

release

public void release()

Release this COM object reference

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setBrokenPathsOnly

public void setBrokenPathsOnly(boolean pbBrokenOnly)
                        throws java.io.IOException,
                               AutomationException

Indicates whether only broken paths are returned.

Specified by:

setBrokenPathsOnly in interface IItemPathsOptions

Parameters:

pbBrokenOnly - The pbBrokenOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isBrokenPathsOnly

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

Indicates whether only broken paths are returned.

Specified by:

isBrokenPathsOnly in interface IItemPathsOptions

Returns:

The pbBrokenOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setFoldersOnly

public void setFoldersOnly(boolean pbFoldersOnly)
                    throws java.io.IOException,
                           AutomationException

Indicates whether only folder paths are returned.

Specified by:

setFoldersOnly in interface IItemPathsOptions

Parameters:

pbFoldersOnly - The pbFoldersOnly (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isFoldersOnly

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

Indicates whether only folder paths are returned.

Specified by:

isFoldersOnly in interface IItemPathsOptions

Returns:

The pbFoldersOnly

Throws:

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

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

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

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.