com.esri.arcgis.datasourcesraster
Interface IQueryPathsParameters

All Superinterfaces:
Serializable
All Known Implementing Classes:
IQueryPathsParametersProxy, QueryPathsParameters

public interface IQueryPathsParameters
extends Serializable

Provides access to members that control parameters to query paths.

Product Availability

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


Method Summary
 int getPathDepth()
          The maximum depth of each folder path returned.
 boolean isBrokenPathsOnly()
          Indicates whether only broken paths are returned.
 boolean isFoldersOnly()
          Indicates whether only folder paths are returned.
 boolean isQueryDatasetPaths()
          Indicates whether paths associated with each raster dataset is queried.
 boolean isQueryItemURIPaths()
          Indicates whether paths from URI objects that identify source to the raster type are queried.
 void setBrokenPathsOnly(boolean pbBrokenOnly)
          Indicates whether only broken paths are returned.
 void setFoldersOnly(boolean pbFoldersOnly)
          Indicates whether only folder paths are returned.
 void setPathDepth(int pPathDepth)
          The maximum depth of each folder path returned.
 void setQueryDatasetPaths(boolean pbQueryDatasetPaths)
          Indicates whether paths associated with each raster dataset is queried.
 void setQueryItemURIPaths(boolean pbQueryURIPaths)
          Indicates whether paths from URI objects that identify source to the raster type are queried.
 

Method Detail

setQueryDatasetPaths

void setQueryDatasetPaths(boolean pbQueryDatasetPaths)
                          throws IOException,
                                 AutomationException
Indicates whether paths associated with each raster dataset is queried.

Product Availability

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

Parameters:
pbQueryDatasetPaths - The pbQueryDatasetPaths (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isQueryDatasetPaths

boolean isQueryDatasetPaths()
                            throws IOException,
                                   AutomationException
Indicates whether paths associated with each raster dataset is queried.

Product Availability

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

Returns:
The pbQueryDatasetPaths
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setQueryItemURIPaths

void setQueryItemURIPaths(boolean pbQueryURIPaths)
                          throws IOException,
                                 AutomationException
Indicates whether paths from URI objects that identify source to the raster type are queried.

Product Availability

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

Parameters:
pbQueryURIPaths - The pbQueryURIPaths (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isQueryItemURIPaths

boolean isQueryItemURIPaths()
                            throws IOException,
                                   AutomationException
Indicates whether paths from URI objects that identify source to the raster type are queried.

Product Availability

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

Returns:
The pbQueryURIPaths
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBrokenPathsOnly

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.

Parameters:
pbBrokenOnly - The pbBrokenOnly (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isBrokenPathsOnly

boolean isBrokenPathsOnly()
                          throws IOException,
                                 AutomationException
Indicates whether only broken paths are returned.

Product Availability

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

Returns:
The pbBrokenOnly
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFoldersOnly

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.

Parameters:
pbFoldersOnly - The pbFoldersOnly (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFoldersOnly

boolean isFoldersOnly()
                      throws IOException,
                             AutomationException
Indicates whether only folder paths are returned.

Product Availability

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

Returns:
The pbFoldersOnly
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPathDepth

void setPathDepth(int pPathDepth)
                  throws IOException,
                         AutomationException
The maximum depth of each folder path returned.

Product Availability

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

Parameters:
pPathDepth - The pPathDepth (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPathDepth

int getPathDepth()
                 throws IOException,
                        AutomationException
The maximum depth of each folder path returned.

Product Availability

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

Returns:
The pPathDepth
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.