com.esri.arcgis.carto
Class EditTemplate

java.lang.Object
  extended by com.esri.arcgis.carto.EditTemplate
All Implemented Interfaces:
IEditTemplate, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class EditTemplate
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IEditTemplate, IPersist, IPersistStream, java.io.Externalizable

COM Class 'EditTemplate'. Generated 3/19/2015 1:20:41 PM from 'C:\ArcGIS\COM\esriCarto.olb'

Description 'EditTemplate Class' 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 =

See Also:
Serialized Form

Field Summary
static long serialVersionUID
           
 
Fields inherited from interface com.esri.arcgis.carto.IEditTemplate
IID, IID0952f6c1_5e9d_4e2e_bc99_ed55bcc4c6ce, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersistStream
IID, IID00000109_0000_0000_c000_000000000046, xxDummy
 
Fields inherited from interface com.esri.arcgis.system.IPersist
IID0000010c_0000_0000_c000_000000000046
 
Constructor Summary
EditTemplate()
          Constructs a EditTemplate using ArcGIS Engine.
EditTemplate(java.lang.Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EditTemplate theEditTemplate = (EditTemplate) obj;
 
Method Summary
 void clearDefaultValues()
          Removes all the default values currently set.
 boolean equals(java.lang.Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static java.lang.String getClsid()
          getClsid.
 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.
 com.esri.arcgis.interop.Dispatch getJintegraDispatch()
          Deprecated. Internal use only.
 ILayer getLayer()
          Gets the layer of the template.
 java.lang.String getName()
          Gets the name of the template.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 java.lang.String getTags()
          The tags of the item.
 GUID getTool()
          Gets the tool for the template.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(java.io.ObjectInput in)
           
 void release()
          Release a EditTemplate.
 void save(IStream pstm, int fClearDirty)
          save
 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.
 void writeExternal(java.io.ObjectOutput out)
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

serialVersionUID

public static final long serialVersionUID
See Also:
Constant Field Values
Constructor Detail

EditTemplate

public EditTemplate()
             throws java.io.IOException,
                    java.net.UnknownHostException
Constructs a EditTemplate using ArcGIS Engine.

Throws:
java.io.IOException - if there are interop problems
java.net.UnknownHostException - if there are interop problems

EditTemplate

public EditTemplate(java.lang.Object obj)
             throws java.io.IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
EditTemplate theEditTemplate = (EditTemplate) obj;

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

Parameters:
obj - an object returned from ArcGIS Engine or Server
Throws:
java.io.IOException - if there are interop problems
Method Detail

getClsid

public static java.lang.String getClsid()
getClsid.


equals

public boolean equals(java.lang.Object o)
Compare this object with another

Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
the hashcode for this object

Overrides:
hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
Deprecated. Internal use only.

Specified by:
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()
Release a EditTemplate.

Specified by:
release in interface com.esri.arcgis.interop.RemoteObjRef

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException
Gets the name of the template.

Specified by:
getName in interface IEditTemplate
Returns:
The name
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String name)
             throws java.io.IOException,
                    AutomationException
Gets the name of the template.

Specified by:
setName in interface IEditTemplate
Parameters:
name - The name (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDescription

public java.lang.String getDescription()
                                throws java.io.IOException,
                                       AutomationException
Gets the description of the template.

Specified by:
getDescription in interface IEditTemplate
Returns:
The description
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDescription

public void setDescription(java.lang.String description)
                    throws java.io.IOException,
                           AutomationException
Gets the description of the template.

Specified by:
setDescription in interface IEditTemplate
Parameters:
description - The description (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLayer

public ILayer getLayer()
                throws java.io.IOException,
                       AutomationException
Gets the layer of the template.

Specified by:
getLayer in interface IEditTemplate
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

public void setLayerByRef(ILayer layer)
                   throws java.io.IOException,
                          AutomationException
Gets the layer of the template.

Specified by:
setLayerByRef in interface IEditTemplate
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

public GUID getTool()
             throws java.io.IOException,
                    AutomationException
Gets the tool for the template.

Specified by:
getTool in interface IEditTemplate
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

public void setTool(GUID tool)
             throws java.io.IOException,
                    AutomationException
Gets the tool for the template.

Specified by:
setTool in interface IEditTemplate
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

public void clearDefaultValues()
                        throws java.io.IOException,
                               AutomationException
Removes all the default values currently set.

Specified by:
clearDefaultValues in interface IEditTemplate
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDefaultValue

public java.lang.Object getDefaultValue(java.lang.String field)
                                 throws java.io.IOException,
                                        AutomationException
Gets the default value for the given field.

Specified by:
getDefaultValue in interface IEditTemplate
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

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

Specified by:
setDefaultValue in interface IEditTemplate
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

public void setDefaultValues(IFeature feature)
                      throws java.io.IOException,
                             AutomationException
Sets the default values on the given feature.

Specified by:
setDefaultValues in interface IEditTemplate
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

public int getCreateCount()
                   throws java.io.IOException,
                          AutomationException
Returns the number of times this template has created a feature.

Specified by:
getCreateCount in interface IEditTemplate
Returns:
The count
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getTags

public java.lang.String getTags()
                         throws java.io.IOException,
                                AutomationException
The tags of the item.

Specified by:
getTags in interface IEditTemplate
Returns:
The tags
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTags

public void setTags(java.lang.String tags)
             throws java.io.IOException,
                    AutomationException
The tags of the item.

Specified by:
setTags in interface IEditTemplate
Parameters:
tags - The tags (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws java.io.IOException,
                       AutomationException
getClassID

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException
isDirty

Specified by:
isDirty in interface IPersistStream
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException
load

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws java.io.IOException,
                 AutomationException
save

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws java.io.IOException,
                       AutomationException
getSizeMax

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
java.io.IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException
Specified by:
writeExternal in interface java.io.Externalizable
Throws:
java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Specified by:
readExternal in interface java.io.Externalizable
Throws:
java.io.IOException
java.lang.ClassNotFoundException