com.esri.arcgis.arcweb
Interface IArcWebSite

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArcWebSite

public interface IArcWebSite
extends Serializable

Provides access to members that describe the area of the report.

Product Availability

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


Method Summary
 int getCalcType()
          The type of rings (default is esriArcWebReportCalcTypeSolid).
 IGeometryCollection getPolygons()
          The areas for the report.
 IDoubleArray getRingsRadii()
          The radii of the rings.
 int getRingsUnits()
          The units for the ring's radius (default is esriArcWebDistanceUnitsMiles).
 IPoint getSiteLocation()
          The x,y coordinates used to define either the center of the rings or a reference point for the polygons.
 String getSiteName()
          The site name.
 void setCalcType(int calcType)
          The type of rings (default is esriArcWebReportCalcTypeSolid).
 void setPolygons(IGeometryCollection polygons)
          The areas for the report.
 void setRingsRadii(IDoubleArray ringsRadii)
          The radii of the rings.
 void setRingsUnits(int ringsUnits)
          The units for the ring's radius (default is esriArcWebDistanceUnitsMiles).
 void setSiteLocation(IPoint siteLocation)
          The x,y coordinates used to define either the center of the rings or a reference point for the polygons.
 void setSiteName(String siteName)
          The site name.
 

Method Detail

getCalcType

int getCalcType()
                throws IOException,
                       AutomationException
The type of rings (default is esriArcWebReportCalcTypeSolid).

Product Availability

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

Returns:
A com.esri.arcgis.arcweb.esriArcWebReportCalcType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setCalcType

void setCalcType(int calcType)
                 throws IOException,
                        AutomationException
The type of rings (default is esriArcWebReportCalcTypeSolid).

Product Availability

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

Parameters:
calcType - A com.esri.arcgis.arcweb.esriArcWebReportCalcType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPolygons

IGeometryCollection getPolygons()
                                throws IOException,
                                       AutomationException
The areas for the report.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IGeometryCollection
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPolygons

void setPolygons(IGeometryCollection polygons)
                 throws IOException,
                        AutomationException
The areas for the report.

Product Availability

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

Parameters:
polygons - A reference to a com.esri.arcgis.geometry.IGeometryCollection (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRingsRadii

IDoubleArray getRingsRadii()
                           throws IOException,
                                  AutomationException
The radii of the rings.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.system.IDoubleArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRingsRadii

void setRingsRadii(IDoubleArray ringsRadii)
                   throws IOException,
                          AutomationException
The radii of the rings.

Product Availability

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

Parameters:
ringsRadii - A reference to a com.esri.arcgis.system.IDoubleArray (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getRingsUnits

int getRingsUnits()
                  throws IOException,
                         AutomationException
The units for the ring's radius (default is esriArcWebDistanceUnitsMiles).

Product Availability

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

Returns:
A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setRingsUnits

void setRingsUnits(int ringsUnits)
                   throws IOException,
                          AutomationException
The units for the ring's radius (default is esriArcWebDistanceUnitsMiles).

Product Availability

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

Parameters:
ringsUnits - A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSiteLocation

IPoint getSiteLocation()
                       throws IOException,
                              AutomationException
The x,y coordinates used to define either the center of the rings or a reference point for the polygons.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setSiteLocation

void setSiteLocation(IPoint siteLocation)
                     throws IOException,
                            AutomationException
The x,y coordinates used to define either the center of the rings or a reference point for the polygons.

Product Availability

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

Parameters:
siteLocation - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSiteName

String getSiteName()
                   throws IOException,
                          AutomationException
The site name.

Product Availability

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

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

setSiteName

void setSiteName(String siteName)
                 throws IOException,
                        AutomationException
The site name.

Product Availability

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

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