com.esri.arcgis.trackinganalyst
Interface ITimeRegionalSettings

All Superinterfaces:
Serializable
All Known Implementing Classes:
TemporalFeatureLayer

public interface ITimeRegionalSettings
extends Serializable

Provides access to properties and methods needed to change the parsing behavior of a string temporal field. These properties and methods are not used for date type temporal fields and this information is not used for realtime data sources.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.


Method Summary
 String getAMDesignator()
          String for the AM designator.
 String getDateStyleFormat()
          Date style used when parsing the date portion of a time string in the temporal column.
 int getLanguageLocaleID()
          Language ID used to parse dates from string values.
 String getPMDesignator()
          String for the PM designator.
 String getTimeStyleFormat()
          Time formatting style used to parse the time portion of a time string in the temporal column.
 void setAMDesignator(String pbstrAMDesignator)
          String for the AM designator.
 void setDateStyleFormat(String pbstrDateStyleFormat)
          Date style used when parsing the date portion of a time string in the temporal column.
 void setLanguageLocaleID(int plLanguageLocaleID)
          Language ID used to parse dates from string values.
 void setPMDesignator(String pbstrPMDesignator)
          String for the PM designator.
 void setTimeStyleFormat(String pbstrTimeStyleFormat)
          Time formatting style used to parse the time portion of a time string in the temporal column.
 

Method Detail

getLanguageLocaleID

int getLanguageLocaleID()
                        throws IOException,
                               AutomationException
Language ID used to parse dates from string values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

setLanguageLocaleID

void setLanguageLocaleID(int plLanguageLocaleID)
                         throws IOException,
                                AutomationException
Language ID used to parse dates from string values.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getTimeStyleFormat

String getTimeStyleFormat()
                          throws IOException,
                                 AutomationException
Time formatting style used to parse the time portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

setTimeStyleFormat

void setTimeStyleFormat(String pbstrTimeStyleFormat)
                        throws IOException,
                               AutomationException
Time formatting style used to parse the time portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getDateStyleFormat

String getDateStyleFormat()
                          throws IOException,
                                 AutomationException
Date style used when parsing the date portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

setDateStyleFormat

void setDateStyleFormat(String pbstrDateStyleFormat)
                        throws IOException,
                               AutomationException
Date style used when parsing the date portion of a time string in the temporal column.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getAMDesignator

String getAMDesignator()
                       throws IOException,
                              AutomationException
String for the AM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

setAMDesignator

void setAMDesignator(String pbstrAMDesignator)
                     throws IOException,
                            AutomationException
String for the AM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

getPMDesignator

String getPMDesignator()
                       throws IOException,
                              AutomationException
String for the PM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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

setPMDesignator

void setPMDesignator(String pbstrPMDesignator)
                     throws IOException,
                            AutomationException
String for the PM designator.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server. Requires Tracking Analyst Extension.

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