com.esri.arcgis.datasourcesfile
Interface ISMStopsCollection

All Superinterfaces:

Serializable

All Known Implementing Classes:

SMStopsCollection

public interface ISMStopsCollection
extends Serializable

Provides access to the collection of route stops.

Description

Represents the collection of route stops.

Product Availability

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

Method Summary

void	add(ISMStop pItem) Adds a stop to the end of collection.
void	clear() Removes all stops from the collection.
int	getCount() The number of stops in the collection.
ISMStop	getItem(int position) The stop at the specified position in the collection.
void	insert(int position, ISMStop pItem) Inserts a stop at the specified position in the collection.
void	remove(int position) Removes the stop at the specified position in the collection.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

The number of stops in the collection.

Description

Returns the number of stops in a collection.

Product Availability

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

Returns:

The pVal

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getItem

ISMStop getItem(int position)
                throws IOException,
                       AutomationException

The stop at the specified position in the collection.

Product Availability

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

Parameters:

position - The position (in)

Returns:

A reference to a com.esri.arcgis.datasourcesfile.ISMStop

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(ISMStop pItem)
         throws IOException,
                AutomationException

Adds a stop to the end of collection.

Description

Add a stop to the end of a collection.

Product Availability

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

Parameters:

pItem - A reference to a com.esri.arcgis.datasourcesfile.ISMStop (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int position,
            ISMStop pItem)
            throws IOException,
                   AutomationException

Inserts a stop at the specified position in the collection.

Description

Inserts a stop at a specifed position within a collection.

Product Availability

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

Parameters:

position - The position (in)

pItem - A reference to a com.esri.arcgis.datasourcesfile.ISMStop (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int position)
            throws IOException,
                   AutomationException

Removes the stop at the specified position in the collection.

Description

Removes a stop at a specifed position within a collection.

Product Availability

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

Parameters:

position - The position (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

clear

void clear()
           throws IOException,
                  AutomationException

Removes all stops from the collection.

Description

Removes all stops from the collection.

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.