com.esri.arcgis.datasourcesraster
Class ItemPathsOptions

java.lang.Object
  com.esri.arcgis.datasourcesraster.ItemPathsOptions

All Implemented Interfaces:

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

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

Parameters that indicate path query and replacement options.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ItemPathsOptions()
Constructs a ItemPathsOptions using ArcGIS Engine.

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

Method Summary

Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
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	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

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ItemPathsOptions

public ItemPathsOptions()
                 throws IOException,
                        UnknownHostException

Constructs a ItemPathsOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ItemPathsOptions

public ItemPathsOptions(Object obj)
                 throws 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:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

setBrokenPathsOnly

public void setBrokenPathsOnly(boolean pbBrokenOnly)
                        throws IOException,
                               AutomationException

Indicates whether only broken paths are returned.

Product Availability

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

Specified by:

setBrokenPathsOnly in interface IItemPathsOptions

Parameters:

pbBrokenOnly - The pbBrokenOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isBrokenPathsOnly

public boolean isBrokenPathsOnly()
                          throws IOException,
                                 AutomationException

Indicates whether only broken paths are returned.

Product Availability

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

Specified by:

isBrokenPathsOnly in interface IItemPathsOptions

Returns:

The pbBrokenOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFoldersOnly

public void setFoldersOnly(boolean pbFoldersOnly)
                    throws IOException,
                           AutomationException

Indicates whether only folder paths are returned.

Product Availability

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

Specified by:

setFoldersOnly in interface IItemPathsOptions

Parameters:

pbFoldersOnly - The pbFoldersOnly (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFoldersOnly

public boolean isFoldersOnly()
                      throws IOException,
                             AutomationException

Indicates whether only folder paths are returned.

Product Availability

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

Specified by:

isFoldersOnly in interface IItemPathsOptions

Returns:

The pbFoldersOnly

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws 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:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.