com.esri.arcgis.arcweb
Class ArcWebReportOptions

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

All Implemented Interfaces:

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

public class ArcWebReportOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebReportOptions

A set of parameters used in generating reports.

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArcWebReportOptions()
Constructs a ArcWebReportOptions using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
static String	getClsid() getClsid.
String	getDataSource() The name of the data source used for creating a report.
int	getReportFormat() The format of the report (default is esriArcWebReportFormatPDF).
IEnumArcWebKeyValue	getReportHeader() The key/value pairs for the header of a report (default is null).
int	hashCode() the hashcode for this object
void	setDataSource(String dataSource) The name of the data source used for creating a report.
void	setReportFormat(int reportFormat) The format of the report (default is esriArcWebReportFormatPDF).
void	setReportHeader(IEnumArcWebKeyValue reportHeader) The key/value pairs for the header of a report (default is null).

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

ArcWebReportOptions

public ArcWebReportOptions()
                    throws IOException,
                           UnknownHostException

Constructs a ArcWebReportOptions using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebReportOptions

public ArcWebReportOptions(Object obj)
                    throws IOException

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

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

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

getDataSource

public String getDataSource()
                     throws IOException,
                            AutomationException

The name of the data source used for creating a report.

Product Availability

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

Specified by:

getDataSource in interface IArcWebReportOptions

Returns:

The dataSource

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDataSource

public void setDataSource(String dataSource)
                   throws IOException,
                          AutomationException

The name of the data source used for creating a report.

Product Availability

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

Specified by:

setDataSource in interface IArcWebReportOptions

Parameters:

dataSource - The dataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportFormat

public int getReportFormat()
                    throws IOException,
                           AutomationException

The format of the report (default is esriArcWebReportFormatPDF).

Product Availability

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

Specified by:

getReportFormat in interface IArcWebReportOptions

Returns:

A com.esri.arcgis.arcweb.esriArcWebReportFormat constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportFormat

public void setReportFormat(int reportFormat)
                     throws IOException,
                            AutomationException

The format of the report (default is esriArcWebReportFormatPDF).

Product Availability

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

Specified by:

setReportFormat in interface IArcWebReportOptions

Parameters:

reportFormat - A com.esri.arcgis.arcweb.esriArcWebReportFormat constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportHeader

public IEnumArcWebKeyValue getReportHeader()
                                    throws IOException,
                                           AutomationException

The key/value pairs for the header of a report (default is null).

Product Availability

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

Specified by:

getReportHeader in interface IArcWebReportOptions

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebKeyValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportHeader

public void setReportHeader(IEnumArcWebKeyValue reportHeader)
                     throws IOException,
                            AutomationException

The key/value pairs for the header of a report (default is null).

Product Availability

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

Specified by:

setReportHeader in interface IArcWebReportOptions

Parameters:

reportHeader - A reference to a com.esri.arcgis.arcweb.IEnumArcWebKeyValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.