com.esri.arcgis.datasourcesraster
Interface IItemTemplate

All Superinterfaces:

Serializable

All Known Implementing Classes:

IItemTemplateProxy, ItemTemplate

public interface IItemTemplate
extends Serializable

Provides access to members that control an item template.

Product Availability

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

Method Summary

String	getName() The name of the item template.
String	getOutputDatasetTag() The output dataset tag associated with the item template.
String	getPrimaryInputDatasetTag() Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.
IRasterFunctionTemplate	getRasterFunctionTemplate() The raster function template associated with the item template.
boolean	isEnabled() Indicates whether the item template is active.
boolean	isIntersectFootprints() Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.
void	setEnabled(boolean pbEnabled) Indicates whether the item template is active.
void	setIntersectFootprints(boolean pbIntersectFootprints) Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.
void	setName(String pItemTemplateName) The name of the item template.
void	setOutputDatasetTag(String pOutputDatasetTag) The output dataset tag associated with the item template.
void	setPrimaryInputDatasetTag(String pPrimaryInputDatasetTag) Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.
void	setRasterFunctionTemplateByRef(IRasterFunctionTemplate ppFunctionTemplate) The raster function template associated with the item template.

Method Detail

setName

void setName(String pItemTemplateName)
             throws IOException,
                    AutomationException

The name of the item template.

Product Availability

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

Parameters:

pItemTemplateName - The pItemTemplateName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

String getName()
               throws IOException,
                      AutomationException

The name of the item template.

Product Availability

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

Returns:

The pItemTemplateName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEnabled

void setEnabled(boolean pbEnabled)
                throws IOException,
                       AutomationException

Indicates whether the item template is active.

Product Availability

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

Parameters:

pbEnabled - The pbEnabled (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEnabled

boolean isEnabled()
                  throws IOException,
                         AutomationException

Indicates whether the item template is active.

Product Availability

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

Returns:

The pbEnabled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRasterFunctionTemplateByRef

void setRasterFunctionTemplateByRef(IRasterFunctionTemplate ppFunctionTemplate)
                                    throws IOException,
                                           AutomationException

The raster function template associated with the item template.

Product Availability

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

Parameters:

ppFunctionTemplate - A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRasterFunctionTemplate

IRasterFunctionTemplate getRasterFunctionTemplate()
                                                  throws IOException,
                                                         AutomationException

The raster function template associated with the item template.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.datasourcesraster.IRasterFunctionTemplate

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputDatasetTag

void setOutputDatasetTag(String pOutputDatasetTag)
                         throws IOException,
                                AutomationException

The output dataset tag associated with the item template. This property determines the tag of the outgoing item constructed using this template.

Product Availability

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

Parameters:

pOutputDatasetTag - The pOutputDatasetTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputDatasetTag

String getOutputDatasetTag()
                           throws IOException,
                                  AutomationException

The output dataset tag associated with the item template. This property determines the tag of the outgoing item constructed using this template.

Product Availability

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

Returns:

The pOutputDatasetTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPrimaryInputDatasetTag

void setPrimaryInputDatasetTag(String pPrimaryInputDatasetTag)
                               throws IOException,
                                      AutomationException

Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.

Product Availability

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

Parameters:

pPrimaryInputDatasetTag - The pPrimaryInputDatasetTag (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPrimaryInputDatasetTag

String getPrimaryInputDatasetTag()
                                 throws IOException,
                                        AutomationException

Tag identifying the item URI that references a dataset from which all properties are copied over to the outgoing dataset.

Product Availability

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

Returns:

The pPrimaryInputDatasetTag

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIntersectFootprints

void setIntersectFootprints(boolean pbIntersectFootprints)
                            throws IOException,
                                   AutomationException

Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.

Product Availability

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

Parameters:

pbIntersectFootprints - The pbIntersectFootprints (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIntersectFootprints

boolean isIntersectFootprints()
                              throws IOException,
                                     AutomationException

Indicates whether the footprint of items constructed using this template is computed using the intersection of the footprints of all participating input items.

Product Availability

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

Returns:

The pbIntersectFootprints

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.