com.esri.arcgis.controls
Interface IEngineNAWindowCategoryGroup

All Superinterfaces:
Serializable
All Known Implementing Classes:
IEngineNAWindowCategoryGroupProxy

public interface IEngineNAWindowCategoryGroup
extends Serializable

Provides access to the window category group.

Description

The IEngineNAWindowCategoryGroup interface is used to access the category and group of a category that supports groups in the IEngineNetworkAnalystEnvironment::NAWindow.

Currently "Stops" is the only category that can have groups. For "Stops", there is a group for each unique RouteName in the "Stops" NAClass.

Product Availability

Available with ArcGIS Engine.


Method Summary
 IEngineNAWindowCategory getCategory()
          The NAWindow category.
 String getGroup()
          The NAWindow category group name.
 void setCategoryByRef(IEngineNAWindowCategory category)
          The NAWindow category.
 void setGroup(String group)
          The NAWindow category group name.
 

Method Detail

setCategoryByRef

void setCategoryByRef(IEngineNAWindowCategory category)
                      throws IOException,
                             AutomationException
The NAWindow category.

Product Availability

Available with ArcGIS Engine.

Parameters:
category - A reference to a com.esri.arcgis.controls.IEngineNAWindowCategory (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCategory

IEngineNAWindowCategory getCategory()
                                    throws IOException,
                                           AutomationException
The NAWindow category.

Description

A reference to the IEngineNAWindowCategory that the category group is part of. For example, if a stop in the "Route1" category group of the stops category was active, the Category would reference the "Stops" IEngineNAWindowCategory.

Product Availability

Available with ArcGIS Engine.

Returns:
A reference to a com.esri.arcgis.controls.IEngineNAWindowCategory
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGroup

String getGroup()
                throws IOException,
                       AutomationException
The NAWindow category group name.

Description

The name of the group.

Product Availability

Available with ArcGIS Engine.

Returns:
The group
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGroup

void setGroup(String group)
              throws IOException,
                     AutomationException
The NAWindow category group name.

Product Availability

Available with ArcGIS Engine.

Parameters:
group - The group (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.