com.esri.arcgis.arcmap
Interface IReportTemplate

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

IReportTemplateProxy, Report

public interface IReportTemplate
extends java.io.Serializable

COM Interface 'IReportTemplate'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriArcMap.olb'

Description: 'Provides access to template members of a report.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID4ba9f129_fea1_4caf_b29f_349df95deee8
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	fieldMapping(java.lang.String templateFieldList, java.lang.String sourceFieldList) Sets the field mapping from the report template to the new fields.
java.lang.String	getReportTitle() Indicates the title for the report.
int	getStartingPageNumber() Indicates the starting page number for the report.
boolean	loadReportTemplate(java.lang.String templateFilePath) Loads the report template file.
boolean	relatedReportMapping(java.lang.String relatedReportName, IRelationshipClass pSourceRelationshipClass, java.lang.String templateFieldList, java.lang.String sourceFieldList) Sets the mapping information for a related report.
boolean	saveReportTemplate(java.lang.String templateFilePath) Saves the report as a template file.
void	setReportTitle(java.lang.String pReportTitle) Indicates the title for the report.
void	setStartingPageNumber(int pStartingPageNumber) Indicates the starting page number for the report.

Field Detail

IID4ba9f129_fea1_4caf_b29f_349df95deee8

static final int IID4ba9f129_fea1_4caf_b29f_349df95deee8

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getStartingPageNumber

int getStartingPageNumber()
                          throws java.io.IOException,
                                 AutomationException

Indicates the starting page number for the report.

Returns:

The pStartingPageNumber

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingPageNumber

void setStartingPageNumber(int pStartingPageNumber)
                           throws java.io.IOException,
                                  AutomationException

Indicates the starting page number for the report.

Parameters:

pStartingPageNumber - The pStartingPageNumber (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportTitle

java.lang.String getReportTitle()
                                throws java.io.IOException,
                                       AutomationException

Indicates the title for the report.

Returns:

The pReportTitle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportTitle

void setReportTitle(java.lang.String pReportTitle)
                    throws java.io.IOException,
                           AutomationException

Indicates the title for the report.

Parameters:

pReportTitle - The pReportTitle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fieldMapping

boolean fieldMapping(java.lang.String templateFieldList,
                     java.lang.String sourceFieldList)
                     throws java.io.IOException,
                            AutomationException

Sets the field mapping from the report template to the new fields.

Parameters:

templateFieldList - The templateFieldList (in)

sourceFieldList - The sourceFieldList (in)

Returns:

The pResult

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedReportMapping

boolean relatedReportMapping(java.lang.String relatedReportName,
                             IRelationshipClass pSourceRelationshipClass,
                             java.lang.String templateFieldList,
                             java.lang.String sourceFieldList)
                             throws java.io.IOException,
                                    AutomationException

Sets the mapping information for a related report.

Parameters:

relatedReportName - The relatedReportName (in)

pSourceRelationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

templateFieldList - The templateFieldList (in)

sourceFieldList - The sourceFieldList (in)

Returns:

The pResult

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadReportTemplate

boolean loadReportTemplate(java.lang.String templateFilePath)
                           throws java.io.IOException,
                                  AutomationException

Loads the report template file.

Parameters:

templateFilePath - The templateFilePath (in)

Returns:

The pResult

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveReportTemplate

boolean saveReportTemplate(java.lang.String templateFilePath)
                           throws java.io.IOException,
                                  AutomationException

Saves the report as a template file.

Parameters:

templateFilePath - The templateFilePath (in)

Returns:

The pResult

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.