com.esri.arcgis.schematic
Interface ISchematicElementClass

All Superinterfaces:

IClass, IObjectClass, Serializable

All Known Implementing Classes:

ISchematicElementClassProxy, SchematicElementClass

public interface ISchematicElementClass
extends IObjectClass, Serializable

Provides access to members that control the schematic element class.

Product Availability

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

See Also:

ISchematicElement, INgElementType

Method Summary

void	alterAssociatedObjectClass(int dataSourceID, int objectClassID) Changes the feature class associated with the schematic element class with the new specified datasource ID and the new specified feature class ID.
void	alterBuilderPropertySet(IPropertySet propertySet) Changes the builder PropertySet defined for the schematic element class with the new specified builder PropertySet.
void	alterQuery(int dataSourceID, IPropertySet propertySet) Changes the query related to the schematic element class with the new specified datasource ID and the new specified query PropertySet.
ISchematicElement	createSchematicElement(String name, ISchematicDiagram schematicDiagram) Creates a new schematic element in the specified schematic diagram.
int	getAssociatedDataSourceID() Datasource ID of the feature class associated with the schematic element class.
IEnumSchematicDiagramClass	getAssociatedDiagramClasses() List of the schematic diagram classes associated to the schematic element class.
int	getAssociatedObjectClassID() ID of the feature class associated with the schematic element class.
IPropertySet	getBuilderPropertySet() Builder property set related to the schematic element class.
int	getDataSourceID() ID of the datasource related to the schematic element class.
ISchematicElementClass	getParent() Parent element class of the schematic element class.
IPropertySet	getQueryPropertySet() Query PropertySet related to the schematic element class.
IUID	getRelationManagerCLSID() CLSID of the relation manager defined for the schematic elemnt class.
ISchematicDataset	getSchematicDataset() Schematic dataset related to the schematic element class.
ISchematicElement	getSchematicElementByID(int iD, ISchematicDiagram schematicDiagram) Schematic element referenced by the specified ID that is contained in the specified schematic diagram.
ISchematicElement	getSchematicElementByName(String name, ISchematicDiagram schematicDiagram) Schematic element referenced by the specified Name that is contained in the specified schematic diagram.
IEnumSchematicElement	getSchematicElements(ISchematicDiagram schematicDiagram) List of the schematic elements related to the schematic element class within the specified schematic diagram.
int	getSchematicElementType() Schematic element type related to the schematic element class.
void	setParentByRef(ISchematicElementClass parent) Parent element class of the schematic element class.
void	setRelationManagerCLSID(IUID uID) CLSID of the relation manager defined for the schematic elemnt class.

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

getAliasName, getObjectClassID, getRelationshipClasses

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

addField, addIndex, deleteField, deleteIndex, findField, getCLSID, getEXTCLSID, getExtension, getExtensionProperties, getFields, getIndexes, getOIDFieldName, isHasOID

Method Detail

getParent

ISchematicElementClass getParent()
                                 throws IOException,
                                        AutomationException

Parent element class of the schematic element class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setParentByRef

void setParentByRef(ISchematicElementClass parent)
                    throws IOException,
                           AutomationException

Parent element class of the schematic element class.

Product Availability

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

Parameters:

parent - A reference to a com.esri.arcgis.schematic.ISchematicElementClass (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDataset

ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException

Schematic dataset related to the schematic element class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementType

int getSchematicElementType()
                            throws IOException,
                                   AutomationException

Schematic element type related to the schematic element class.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicElementType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSchematicElement

ISchematicElement createSchematicElement(String name,
                                         ISchematicDiagram schematicDiagram)
                                         throws IOException,
                                                AutomationException

Creates a new schematic element in the specified schematic diagram.

Product Availability

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

Parameters:

name - The name (in)

schematicDiagram - A reference to a com.esri.arcgis.schematic.ISchematicDiagram (in)

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.

getSchematicElements

IEnumSchematicElement getSchematicElements(ISchematicDiagram schematicDiagram)
                                           throws IOException,
                                                  AutomationException

List of the schematic elements related to the schematic element class within the specified schematic diagram.

Product Availability

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

Parameters:

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicElementByID

ISchematicElement getSchematicElementByID(int iD,
                                          ISchematicDiagram schematicDiagram)
                                          throws IOException,
                                                 AutomationException

Schematic element referenced by the specified ID that is contained in the specified schematic diagram.

Product Availability

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

Parameters:

iD - The iD (in)

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

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.

getSchematicElementByName

ISchematicElement getSchematicElementByName(String name,
                                            ISchematicDiagram schematicDiagram)
                                            throws IOException,
                                                   AutomationException

Schematic element referenced by the specified Name that is contained in the specified schematic diagram.

Product Availability

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

Parameters:

name - The name (in)

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

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.

getBuilderPropertySet

IPropertySet getBuilderPropertySet()
                                   throws IOException,
                                          AutomationException

Builder property set related to the schematic element class.

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.

See Also:

ISchematicElementClass.alterBuilderPropertySet(com.esri.arcgis.system.IPropertySet)

alterBuilderPropertySet

void alterBuilderPropertySet(IPropertySet propertySet)
                             throws IOException,
                                    AutomationException

Changes the builder PropertySet defined for the schematic element class with the new specified builder PropertySet.

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.

See Also:

ISchematicElementClass.getBuilderPropertySet()

getDataSourceID

int getDataSourceID()
                    throws IOException,
                           AutomationException

ID of the datasource related to the schematic element class.

Product Availability

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

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicElementClass.getAssociatedDataSourceID()

getQueryPropertySet

IPropertySet getQueryPropertySet()
                                 throws IOException,
                                        AutomationException

Query PropertySet related to the schematic element class.

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.

alterQuery

void alterQuery(int dataSourceID,
                IPropertySet propertySet)
                throws IOException,
                       AutomationException

Changes the query related to the schematic element class with the new specified datasource ID and the new specified query PropertySet.

Product Availability

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

Parameters:

dataSourceID - The dataSourceID (in)

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.

getAssociatedDataSourceID

int getAssociatedDataSourceID()
                              throws IOException,
                                     AutomationException

Datasource ID of the feature class associated with the schematic element class.

Product Availability

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

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

ISchematicElementClass.getDataSourceID()

getAssociatedObjectClassID

int getAssociatedObjectClassID()
                               throws IOException,
                                      AutomationException

ID of the feature class associated with the schematic element class.

Product Availability

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

Returns:

The iD

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

alterAssociatedObjectClass

void alterAssociatedObjectClass(int dataSourceID,
                                int objectClassID)
                                throws IOException,
                                       AutomationException

Changes the feature class associated with the schematic element class with the new specified datasource ID and the new specified feature class ID.

Product Availability

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

Parameters:

dataSourceID - The dataSourceID (in)

objectClassID - The objectClassID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelationManagerCLSID

IUID getRelationManagerCLSID()
                             throws IOException,
                                    AutomationException

CLSID of the relation manager defined for the schematic elemnt class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelationManagerCLSID

void setRelationManagerCLSID(IUID uID)
                             throws IOException,
                                    AutomationException

CLSID of the relation manager defined for the schematic elemnt class.

Product Availability

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

Parameters:

uID - A reference to a com.esri.arcgis.system.IUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getAssociatedDiagramClasses

IEnumSchematicDiagramClass getAssociatedDiagramClasses()
                                                       throws IOException,
                                                              AutomationException

List of the schematic diagram classes associated to the schematic element class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.