com.esri.arcgis.system
Interface IXMLFlags

All Superinterfaces:

Serializable

All Known Implementing Classes:

XMLFlags

public interface IXMLFlags
extends Serializable

Provides access to members that control XML flags.

Product Availability

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

Method Summary

int	getCount() Number of flags.
boolean	getFlag(String name) Indicates whether XML flag is set.
String	getFlagName(int index) Flag name by index.
boolean	isFlagValue(int index) Indicates whether the flag has value by index.
void	setFlag(String name, boolean flagValue) Writes a flag value.

Method Detail

setFlag

void setFlag(String name,
             boolean flagValue)
             throws IOException,
                    AutomationException

Writes a flag value.

Product Availability

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

Parameters:

name - The name (in)

flagValue - The flagValue (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlag

boolean getFlag(String name)
                throws IOException,
                       AutomationException

Indicates whether XML flag is set.

Product Availability

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

Parameters:

name - The name (in)

Returns:

The flagValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCount

int getCount()
             throws IOException,
                    AutomationException

Number of flags.

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.

getFlagName

String getFlagName(int index)
                   throws IOException,
                          AutomationException

Flag name by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFlagValue

boolean isFlagValue(int index)
                    throws IOException,
                           AutomationException

Indicates whether the flag has value by index.

Product Availability

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

Parameters:

index - The index (in)

Returns:

The value

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.