com.esri.arcgis.schematic
Interface ISchematicInMemoryFeature

All Superinterfaces:

IFeature, IObject, IRow, IRowBuffer, ISchematicFeature, Serializable

All Known Subinterfaces:

ISchematicInMemoryFeatureLink, ISchematicInMemoryFeatureNode, ISchematicInMemoryFeatureNodeOnLink, ISchematicInMemoryFeatureSubLink

All Known Implementing Classes:

ISchematicInMemoryFeatureLinkProxy, ISchematicInMemoryFeatureNodeOnLinkProxy, ISchematicInMemoryFeatureNodeProxy, ISchematicInMemoryFeatureProxy, ISchematicInMemoryFeatureSubLinkProxy, SchematicInMemoryFeatureLink, SchematicInMemoryFeatureNode, SchematicInMemoryFeatureNodeOnLink, SchematicInMemoryFeatureSubLink

public interface ISchematicInMemoryFeature
extends ISchematicFeature, Serializable

Provides access to members that manage the schematic in memory feature.

Product Availability

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

Method Summary

void	deleteSecondaryAssociations() Deletes the secondary associations of the in memory feature.
IPropertySet	getPropertySet() Schematic in memory feature property set.
ISchematicElement	getSchematicElement() Schematic element associated to the schematic in memory feature.
ISchematicInMemoryDiagram	getSchematicInMemoryDiagram() Schematic in memory diagram the schematic in memory feature belongs to.
ISchematicRelationManager	getSchematicRelationManager() Schematic relation manager of the schematic in memory feature.
IEnumSchematicInMemoryFeatureAssociation	getSecondaryAssociations() The secondary associations of the in memory feature.
int	getSubtype() Subtype of the schematic in memory feature.
int	getUpdateStatus() Update status of the schematic in memory feature.
Object	getUserData(String userDataName) Provides access to the value of the user data named 'UserDataName'.
boolean	isDisplayed() Indicates whether or not the schematic in memory feature is displayed.
boolean	isInitial() Indicates whether or not the schematic in memory feature is an initial feature.
void	refreshAttributes(IEnumSchematicAttribute attributes, IRow associatedObject) Refreshes a list of attributes of the in memory feature, or refreshes all the attributes if the list is null.
void	removeUserData(String userDataName) Removes the user data named 'UserDataName'.
void	restoreInitialPosition() Restores the initial position of the in memory feature.
void	restoreSavedLayout() Restores the last saved layout of the in memory feature.
void	setDisplayed(boolean displayed) Indicates whether or not the schematic in memory feature is displayed.
void	setInitial(boolean initial) Indicates whether or not the schematic in memory feature is an initial feature.
void	setPropertySetByRef(IPropertySet propertySet) Schematic in memory feature property set.
void	setSubtype(int subtype) Subtype of the schematic in memory feature.
void	setUpdateStatus(int status) Update status of the schematic in memory feature.
void	setUserData(String userDataName, Object value) Changes the value of the user data named 'UserDataName'.

Methods inherited from interface com.esri.arcgis.schematic.ISchematicFeature

getName, getSchematicDiagram, getSchematicElementClass

Methods inherited from interface com.esri.arcgis.geodatabase.IFeature

getExtent, getFeatureType, getShape, getShapeCopy, setShapeByRef

Methods inherited from interface com.esri.arcgis.geodatabase.IObject

esri_getClass

Methods inherited from interface com.esri.arcgis.geodatabase.IRow

delete, getOID, getTable, isHasOID, store

Methods inherited from interface com.esri.arcgis.geodatabase.IRowBuffer

getFields, getValue, setValue

Method Detail

getSchematicElement

ISchematicElement getSchematicElement()
                                      throws IOException,
                                             AutomationException

Schematic element associated to the schematic in memory feature.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicElement

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicInMemoryDiagram

ISchematicInMemoryDiagram getSchematicInMemoryDiagram()
                                                      throws IOException,
                                                             AutomationException

Schematic in memory diagram the schematic in memory feature belongs to.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicInMemoryDiagram

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicRelationManager

ISchematicRelationManager getSchematicRelationManager()
                                                      throws IOException,
                                                             AutomationException

Schematic relation manager of the schematic in memory feature.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.ISchematicRelationManager

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUserData

Object getUserData(String userDataName)
                   throws IOException,
                          AutomationException

Provides access to the value of the user data named 'UserDataName'.

Product Availability

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

Parameters:

userDataName - The userDataName (in)

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUserData

void setUserData(String userDataName,
                 Object value)
                 throws IOException,
                        AutomationException

Changes the value of the user data named 'UserDataName'.

Product Availability

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

Parameters:

userDataName - The userDataName (in)

value - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeUserData

void removeUserData(String userDataName)
                    throws IOException,
                           AutomationException

Removes the user data named 'UserDataName'.

Product Availability

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

Parameters:

userDataName - The userDataName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPropertySet

IPropertySet getPropertySet()
                            throws IOException,
                                   AutomationException

Schematic in memory feature property set.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.IPropertySet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPropertySetByRef

void setPropertySetByRef(IPropertySet propertySet)
                         throws IOException,
                                AutomationException

Schematic in memory feature property set.

Product Availability

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

Parameters:

propertySet - A reference to a com.esri.arcgis.system.IPropertySet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreSavedLayout

void restoreSavedLayout()
                        throws IOException,
                               AutomationException

Restores the last saved layout of the in memory feature.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

restoreInitialPosition

void restoreInitialPosition()
                            throws IOException,
                                   AutomationException

Restores the initial position of the in memory feature.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

refreshAttributes

void refreshAttributes(IEnumSchematicAttribute attributes,
                       IRow associatedObject)
                       throws IOException,
                              AutomationException

Refreshes a list of attributes of the in memory feature, or refreshes all the attributes if the list is null. If an associatedObject is defined it is used to get the values of associated field attributes.

Product Availability

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

Parameters:

attributes - A reference to a com.esri.arcgis.schematic.IEnumSchematicAttribute (in, optional, pass 0 if not required)

associatedObject - A reference to a com.esri.arcgis.geodatabase.IRow (in, optional, pass 0 if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSecondaryAssociations

IEnumSchematicInMemoryFeatureAssociation getSecondaryAssociations()
                                                                  throws IOException,
                                                                         AutomationException

The secondary associations of the in memory feature.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.schematic.IEnumSchematicInMemoryFeatureAssociation

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deleteSecondaryAssociations

void deleteSecondaryAssociations()
                                 throws IOException,
                                        AutomationException

Deletes the secondary associations of the in memory feature.

Product Availability

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubtype

int getSubtype()
               throws IOException,
                      AutomationException

Subtype of the schematic in memory feature.

Product Availability

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

Returns:

The subtype

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubtype

void setSubtype(int subtype)
                throws IOException,
                       AutomationException

Subtype of the schematic in memory feature.

Product Availability

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

Parameters:

subtype - The subtype (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isInitial

boolean isInitial()
                  throws IOException,
                         AutomationException

Indicates whether or not the schematic in memory feature is an initial feature.

Product Availability

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

Returns:

The initial

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitial

void setInitial(boolean initial)
                throws IOException,
                       AutomationException

Indicates whether or not the schematic in memory feature is an initial feature.

Product Availability

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

Parameters:

initial - The initial (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getUpdateStatus

int getUpdateStatus()
                    throws IOException,
                           AutomationException

Update status of the schematic in memory feature.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicUpdateStatus constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setUpdateStatus

void setUpdateStatus(int status)
                     throws IOException,
                            AutomationException

Update status of the schematic in memory feature.

Product Availability

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

Parameters:

status - A com.esri.arcgis.schematic.esriSchematicUpdateStatus constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDisplayed

boolean isDisplayed()
                    throws IOException,
                           AutomationException

Indicates whether or not the schematic in memory feature is displayed.

Product Availability

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

Returns:

The displayed

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDisplayed

void setDisplayed(boolean displayed)
                  throws IOException,
                         AutomationException

Indicates whether or not the schematic in memory feature is displayed.

Product Availability

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

Parameters:

displayed - The displayed (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.