com.esri.arcgis.trackinganalyst
Interface ITemporalObservationsTable

All Superinterfaces:
ITemporalTable, Serializable
All Known Subinterfaces:
ITemporalObservationsTable2
All Known Implementing Classes:
ITemporalObservationsTable2Proxy, ITemporalObservationsTableProxy, TemporalObservationTable

public interface ITemporalObservationsTable
extends ITemporalTable, Serializable

Superseded By

ITemporalObservationsTable2

Product Availability

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


Method Summary
 double getPurgePercentage()
          The percentage of the maximum allowed number of records to delete when the Purge method is called.
 int getPurgeRule()
          Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).
 String getTemporalColumnName()
          The column that is responsible for providing the temporal information.
 Object getThreshold()
          The high-water mark or the number of observations that should not be exceeded Threshold.
 boolean isAutoPurge()
          Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.
 boolean isPersistant()
          Reserved for future.
 void pruneTable()
          Apply the purge rule to the temporal table.
 void queryTemporalExtent(Object[] pvarStartTime, Object[] pvarEndTime)
          Provides the time range of all records in the temporal table.
 void setAutoPurge(boolean pVal)
          Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.
 void setPersistant(boolean pVal)
          Reserved for future.
 void setPurgePercentage(double pVal)
          The percentage of the maximum allowed number of records to delete when the Purge method is called.
 void setPurgeRule(int pVal)
          Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).
 void setTemporalColumnName(String pVal)
          The column that is responsible for providing the temporal information.
 void setThreshold(Object pvarVal)
          The high-water mark or the number of observations that should not be exceeded Threshold.
 
Methods inherited from interface com.esri.arcgis.trackinganalyst.ITemporalTable
addField, createRow, createRowBuffer, deleteField, findField, getFields, getGeometryColumnName, getRow, insert, isHasGeometry, rowCount, search, select, setGeometryColumnName, update
 

Method Detail

isAutoPurge

boolean isAutoPurge()
                    throws IOException,
                           AutomationException
Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.

Product Availability

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

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

setAutoPurge

void setAutoPurge(boolean pVal)
                  throws IOException,
                         AutomationException
Indicates if the observation table will automatically purge observations that meet a specified criteria, Purge Rule, when the high-water mark has been exceeded.

Product Availability

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

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

getThreshold

Object getThreshold()
                    throws IOException,
                           AutomationException
The high-water mark or the number of observations that should not be exceeded Threshold.

Product Availability

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

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

setThreshold

void setThreshold(Object pvarVal)
                  throws IOException,
                         AutomationException
The high-water mark or the number of observations that should not be exceeded Threshold.

Product Availability

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

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

getPurgePercentage

double getPurgePercentage()
                          throws IOException,
                                 AutomationException
The percentage of the maximum allowed number of records to delete when the Purge method is called.

Product Availability

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

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

setPurgePercentage

void setPurgePercentage(double pVal)
                        throws IOException,
                               AutomationException
The percentage of the maximum allowed number of records to delete when the Purge method is called.

Product Availability

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

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

isPersistant

boolean isPersistant()
                     throws IOException,
                            AutomationException
Reserved for future.

Product Availability

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

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

setPersistant

void setPersistant(boolean pVal)
                   throws IOException,
                          AutomationException
Reserved for future.

Product Availability

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

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

getTemporalColumnName

String getTemporalColumnName()
                             throws IOException,
                                    AutomationException
The column that is responsible for providing the temporal information. This column must be a character (date/time string parsable) , date-time, timestamp, or time period.

Product Availability

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

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

setTemporalColumnName

void setTemporalColumnName(String pVal)
                           throws IOException,
                                  AutomationException
The column that is responsible for providing the temporal information. This column must be a character (date/time string parsable) , date-time, timestamp, or time period.

Product Availability

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

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

getPurgeRule

int getPurgeRule()
                 throws IOException,
                        AutomationException
Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).

Product Availability

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

Returns:
A com.esri.arcgis.trackinganalyst.enumPurgeRule constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPurgeRule

void setPurgeRule(int pVal)
                  throws IOException,
                         AutomationException
Identifies the purge rule to apply when PruneTable method is called (via user S/W or auto purge criteria).

Product Availability

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

Parameters:
pVal - A com.esri.arcgis.trackinganalyst.enumPurgeRule constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

pruneTable

void pruneTable()
                throws IOException,
                       AutomationException
Apply the purge rule to the temporal table.

Product Availability

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

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

queryTemporalExtent

void queryTemporalExtent(Object[] pvarStartTime,
                         Object[] pvarEndTime)
                         throws IOException,
                                AutomationException
Provides the time range of all records in the temporal table.

Product Availability

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

Parameters:
pvarStartTime - A Variant (out: use single element array)
pvarEndTime - A Variant (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.