com.esri.arcgis.schematic
Interface ISchematicFolder

All Superinterfaces:

Serializable

All Known Implementing Classes:

ISchematicFolderProxy, SchematicFolder

public interface ISchematicFolder
extends Serializable

Provides access to members that controls the schematic folder.

Description

A schematic folder resides in a schematic dataset and is used to store a collection of schematic diagrams. It can contain subfolders.

Product Availability

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

Method Summary

ISchematicFolder	createSchematicFolder(String name) Creates a new schematic subfolder in the schematic folder.
ISchematicFolderContainer	getFolderContainer() Parent container of the schematic folder.
int	getFolderContainerID() ID of the parent container of the schematic folder.
int	getID() ID of the schematic folder.
ISchematicDataset	getSchematicDataset() Schematic dataset related to the schematic folder.
void	setFolderContainerByRef(ISchematicFolderContainer schematicFolderContainer) Parent container of the schematic folder.

Method Detail

getSchematicDataset

ISchematicDataset getSchematicDataset()
                                      throws IOException,
                                             AutomationException

Schematic dataset related to the schematic folder.

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.

getID

int getID()
          throws IOException,
                 AutomationException

ID of the schematic folder.

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.

getFolderContainerID

int getFolderContainerID()
                         throws IOException,
                                AutomationException

ID of the parent container of the schematic folder. That is, ID of the schematic dataset or ID of the parent folder that contains this schematic folder.

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.

getFolderContainer

ISchematicFolderContainer getFolderContainer()
                                             throws IOException,
                                                    AutomationException

Parent container of the schematic folder.

Product Availability

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

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFolderContainerByRef

void setFolderContainerByRef(ISchematicFolderContainer schematicFolderContainer)
                             throws IOException,
                                    AutomationException

Parent container of the schematic folder.

Product Availability

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

Parameters:

schematicFolderContainer - A reference to a com.esri.arcgis.schematic.ISchematicFolderContainer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createSchematicFolder

ISchematicFolder createSchematicFolder(String name)
                                       throws IOException,
                                              AutomationException

Creates a new schematic subfolder in the schematic folder.

Product Availability

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

Parameters:

name - The name (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.