com.esri.arcgis.schematic
Interface ISchematicObjectClass

All Superinterfaces:

Serializable

All Known Subinterfaces:

ISchematicDiagramClass, ISchematicElementClass

All Known Implementing Classes:

ISchematicDiagramClassProxy, ISchematicElementClassProxy, ISchematicObjectClassProxy, SchematicDiagramClass, SchematicElementClass

public interface ISchematicObjectClass
extends Serializable

Provides access to members that manage the schematic object class.

Product Availability

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

Method Summary

ISchematicAttribute	createSchematicAttribute(String name, IUID uID) Creates a schematic in memory attribute.
void	delete(boolean deleteDescendants) Deletes the schematic object class.
int	getExternalQueryEvaluationMode() External query evaluation mode of the schematic object class.
Object	getIdentifierFieldNames() Identifier fields names of the schematic object class.
String	getName() Name of the schematic object class.
String[]	getPredefinedAttributeNames() Predefined attributes names of the schematic in memory object class.
String	getQueryString() Query string of the schematic object class.
ISchematicDataset	getSchematicDataset() Schematic dataset the schematic object class belongs to.
ISchematicDataSource	getSchematicDataSource() Schematic data source of the schematic object class.
IEnumSchematicQueryParameter	getSchematicQueryParameters() Schematic query parameters of the schematic object class.
void	setExternalQueryEvaluationMode(int externalQueryEvaluationMode) External query evaluation mode of the schematic object class.
void	setIdentifierFieldNames(Object names) Identifier fields names of the schematic object class.
void	setName(String name) Name of the schematic object class.
void	setQueryString(String queryString) Query string of the schematic object class.
void	setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource) Schematic data source of the schematic object class.
void	setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters) Schematic query parameters of the schematic object class.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the schematic object class.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the schematic object class.

Product Availability

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

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDataset

ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException

Schematic dataset the schematic object class belongs to.

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.

getSchematicQueryParameters

IEnumSchematicQueryParameter getSchematicQueryParameters()
                                                         throws IOException,
                                                                AutomationException

Schematic query parameters of the schematic object class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicQueryParameters

void setSchematicQueryParameters(IEnumSchematicQueryParameter queryParameters)
                                 throws IOException,
                                        AutomationException

Schematic query parameters of the schematic object class.

Product Availability

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

Parameters:

queryParameters - A reference to a com.esri.arcgis.schematic.IEnumSchematicQueryParameter (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getQueryString

String getQueryString()
                      throws IOException,
                             AutomationException

Query string of the schematic object class.

Product Availability

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

Returns:

The queryString

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setQueryString

void setQueryString(String queryString)
                    throws IOException,
                           AutomationException

Query string of the schematic object class.

Product Availability

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

Parameters:

queryString - The queryString (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getIdentifierFieldNames

Object getIdentifierFieldNames()
                               throws IOException,
                                      AutomationException

Identifier fields names of the schematic object class.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setIdentifierFieldNames

void setIdentifierFieldNames(Object names)
                             throws IOException,
                                    AutomationException

Identifier fields names of the schematic object class.

Product Availability

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

Parameters:

names - A Variant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSchematicDataSource

ISchematicDataSource getSchematicDataSource()
                                            throws IOException,
                                                   AutomationException

Schematic data source of the schematic object class.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSchematicDataSourceByRef

void setSchematicDataSourceByRef(ISchematicDataSource schematicDataSource)
                                 throws IOException,
                                        AutomationException

Schematic data source of the schematic object class.

Product Availability

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

Parameters:

schematicDataSource - A reference to a com.esri.arcgis.schematic.ISchematicDataSource (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

delete

void delete(boolean deleteDescendants)
            throws IOException,
                   AutomationException

Deletes the schematic object class.

Product Availability

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

Parameters:

deleteDescendants - The deleteDescendants (in, optional, pass true if not required)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSchematicAttribute

ISchematicAttribute createSchematicAttribute(String name,
                                             IUID uID)
                                             throws IOException,
                                                    AutomationException

Creates a schematic in memory attribute.

Product Availability

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

Parameters:

name - The name (in)

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPredefinedAttributeNames

String[] getPredefinedAttributeNames()
                                     throws IOException,
                                            AutomationException

Predefined attributes names of the schematic in memory object class.

Product Availability

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

Returns:

The names

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExternalQueryEvaluationMode

void setExternalQueryEvaluationMode(int externalQueryEvaluationMode)
                                    throws IOException,
                                           AutomationException

External query evaluation mode of the schematic object class.

Product Availability

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

Parameters:

externalQueryEvaluationMode - A com.esri.arcgis.schematic.esriSchematicExternalQueryEvaluationMode constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExternalQueryEvaluationMode

int getExternalQueryEvaluationMode()
                                   throws IOException,
                                          AutomationException

External query evaluation mode of the schematic object class.

Product Availability

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

Returns:

A com.esri.arcgis.schematic.esriSchematicExternalQueryEvaluationMode constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.