com.esri.arcgis.arcweb
Class ArcWebSite

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebSite

All Implemented Interfaces:

IArcWebSite, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArcWebSite
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebSite

The area of the report.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebSite()
Constructs a ArcWebSite using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
int	getCalcType() The type of rings (default is esriArcWebReportCalcTypeSolid).
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

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

ArcWebSite

public ArcWebSite()
           throws IOException,
                  UnknownHostException

Constructs a ArcWebSite using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebSite

public ArcWebSite(Object obj)
           throws IOException

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

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

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

getCalcType

public int getCalcType()
                throws IOException,
                       AutomationException

The type of rings (default is esriArcWebReportCalcTypeSolid).

Product Availability

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

Specified by:

getCalcType in interface IArcWebSite

Returns:

A com.esri.arcgis.arcweb.esriArcWebReportCalcType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCalcType

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

Specified by:

setCalcType in interface IArcWebSite

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

public IGeometryCollection getPolygons()
                                throws IOException,
                                       AutomationException

The areas for the report.

Product Availability

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

Specified by:

getPolygons in interface IArcWebSite

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

public void setPolygons(IGeometryCollection polygons)
                 throws IOException,
                        AutomationException

The areas for the report.

Product Availability

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

Specified by:

setPolygons in interface IArcWebSite

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

public IDoubleArray getRingsRadii()
                           throws IOException,
                                  AutomationException

The radii of the rings.

Product Availability

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

Specified by:

getRingsRadii in interface IArcWebSite

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

public void setRingsRadii(IDoubleArray ringsRadii)
                   throws IOException,
                          AutomationException

The radii of the rings.

Product Availability

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

Specified by:

setRingsRadii in interface IArcWebSite

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

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

Specified by:

getRingsUnits in interface IArcWebSite

Returns:

A com.esri.arcgis.arcweb.esriArcWebDistanceUnits constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRingsUnits

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

Specified by:

setRingsUnits in interface IArcWebSite

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

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

Specified by:

getSiteLocation in interface IArcWebSite

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

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

Specified by:

setSiteLocation in interface IArcWebSite

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

public String getSiteName()
                   throws IOException,
                          AutomationException

The site name.

Product Availability

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

Specified by:

getSiteName in interface IArcWebSite

Returns:

The siteName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSiteName

public void setSiteName(String siteName)
                 throws IOException,
                        AutomationException

The site name.

Product Availability

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

Specified by:

setSiteName in interface IArcWebSite

Parameters:

siteName - The siteName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.