com.esri.arcgis.carto
Interface IEditTemplate

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

EditTemplate, IEditTemplateProxy

public interface IEditTemplate
extends java.io.Serializable

COM Interface 'IEditTemplate'. Generated 3/19/2015 1:20:52 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description: 'IEditTemplate Interface' 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	IID0952f6c1_5e9d_4e2e_bc99_ed55bcc4c6ce
static int	xxDummy Deprecated. Internal use only

Method Summary

void	clearDefaultValues() Removes all the default values currently set.
int	getCreateCount() Returns the number of times this template has created a feature.
java.lang.Object	getDefaultValue(java.lang.String field) Gets the default value for the given field.
java.lang.String	getDescription() Gets the description of the template.
ILayer	getLayer() Gets the layer of the template.
java.lang.String	getName() Gets the name of the template.
java.lang.String	getTags() The tags of the item.
GUID	getTool() Gets the tool for the template.
void	setDefaultValue(java.lang.String field, java.lang.Object value, boolean initDefaultValues) Sets the default value for the given field.
void	setDefaultValues(IFeature feature) Sets the default values on the given feature.
void	setDescription(java.lang.String description) Gets the description of the template.
void	setLayerByRef(ILayer layer) Gets the layer of the template.
void	setName(java.lang.String name) Gets the name of the template.
void	setTags(java.lang.String tags) The tags of the item.
void	setTool(GUID tool) Gets the tool for the template.

Field Detail

IID0952f6c1_5e9d_4e2e_bc99_ed55bcc4c6ce

static final int IID0952f6c1_5e9d_4e2e_bc99_ed55bcc4c6ce

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

getName

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

Gets the name of the template.

Returns:

The name

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setName

void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException

Gets the name of the template.

Parameters:

name - The name (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDescription

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

Gets the description of the template.

Returns:

The description

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDescription

void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException

Gets the description of the template.

Parameters:

description - The description (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getLayer

ILayer getLayer()
                throws java.io.IOException,
                       AutomationException

Gets the layer of the template.

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

void setLayerByRef(ILayer layer)
                   throws java.io.IOException,
                          AutomationException

Gets the layer of the template.

Parameters:

layer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTool

GUID getTool()
             throws java.io.IOException,
                    AutomationException

Gets the tool for the template.

Returns:

A Structure: com.esri.arcgis.support.ms.stdole.GUID

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTool

void setTool(GUID tool)
             throws java.io.IOException,
                    AutomationException

Gets the tool for the template.

Parameters:

tool - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

clearDefaultValues

void clearDefaultValues()
                        throws java.io.IOException,
                               AutomationException

Removes all the default values currently set.

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getDefaultValue

java.lang.Object getDefaultValue(java.lang.String field)
                                 throws java.io.IOException,
                                        AutomationException

Gets the default value for the given field.

Parameters:

field - The field (in)

Returns:

A Variant

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultValue

void setDefaultValue(java.lang.String field,
                     java.lang.Object value,
                     boolean initDefaultValues)
                     throws java.io.IOException,
                            AutomationException

Sets the default value for the given field. If the field is a subtype field it will use initDefaultValues.

Parameters:

field - The field (in)

value - A Variant (in)

initDefaultValues - The initDefaultValues (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setDefaultValues

void setDefaultValues(IFeature feature)
                      throws java.io.IOException,
                             AutomationException

Sets the default values on the given feature.

Parameters:

feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getCreateCount

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

Returns the number of times this template has created a feature.

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getTags

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

The tags of the item.

Returns:

The tags

Throws:

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

AutomationException - If the ArcObject component throws an exception.

setTags

void setTags(java.lang.String tags)
             throws java.io.IOException,
                    AutomationException

The tags of the item.

Parameters:

tags - The tags (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.