com.esri.arcgis.system
Interface IJobMessages

All Superinterfaces:

Serializable

All Known Implementing Classes:

IJobMessagesProxy, JobMessages

public interface IJobMessages
extends Serializable

Provides access to methods that control an array of job messages.

Product Availability

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

Method Summary

void	add(IJobMessage pMsg) Adds job message to the end of the array.
int	getCount() Number of messages.
IJobMessage	getElement(int index) Method to return job message at given index.
void	insert(int index, IJobMessage pMsg) Inserts job message at the given index.
void	remove(int index) Removes job message at the given index.
void	removeAll() Removes all job messages from the array.

Method Detail

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of messages.

Product Availability

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

Returns:

The count

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getElement

IJobMessage getElement(int index)
                       throws IOException,
                              AutomationException

Method to return job message at given index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

add

void add(IJobMessage pMsg)
         throws IOException,
                AutomationException

Adds job message to the end of the array.

Product Availability

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

Parameters:

pMsg - A reference to a com.esri.arcgis.system.IJobMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

insert

void insert(int index,
            IJobMessage pMsg)
            throws IOException,
                   AutomationException

Inserts job message at the given index.

Product Availability

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

Parameters:

index - The index (in)

pMsg - A reference to a com.esri.arcgis.system.IJobMessage (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

remove

void remove(int index)
            throws IOException,
                   AutomationException

Removes job message at the given index.

Product Availability

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

Parameters:

index - The index (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

removeAll

void removeAll()
               throws IOException,
                      AutomationException

Removes all job messages from the array.

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.