com.esri.arcgis.geodatabase
Interface IHistoricalWorkspace

All Superinterfaces:
Serializable
All Known Implementing Classes:
IHistoricalWorkspaceProxy

public interface IHistoricalWorkspace
extends Serializable

Description

The IHistoricalWorkspace interface can be used to detect existing historical markers while also providing the functionality to add or remove historical markers from the workspace. This interface can also be leveraged to query existing historical versions on the historical workspace.

Product Availability

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


Method Summary
 IHistoricalMarker addHistoricalMarker(String name, Object tstamp)
          Add a historical marker to this workspace.
 IHistoricalVersion findHistoricalVersionByName(String historicalMarkerName)
          Open a historical version by specifying a historical marker name.
 IHistoricalVersion findHistoricalVersionByTimeStamp(Object tstamp)
          Open a historical version by specifying a timestamp.
 String getDefaultMarkerName()
          The marker name which represents the last save or post of the default transactional version.
 IEnumHistoricalMarker getHistoricalMarkers()
          An enumerator of all historical markers managed by this workspace.
 void removeHistoricalMarker(String name)
          Remove a historical marker from this workspace.
 

Method Detail

getDefaultMarkerName

String getDefaultMarkerName()
                            throws IOException,
                                   AutomationException
The marker name which represents the last save or post of the default transactional version.

Remarks

The DefaultMarkerName property returns a string which represents the last save or post of the default transactional version.

Product Availability

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

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

getHistoricalMarkers

IEnumHistoricalMarker getHistoricalMarkers()
                                           throws IOException,
                                                  AutomationException
An enumerator of all historical markers managed by this workspace.

Remarks

The HistoricalMarkers property returns an enumeration of the historical markers that exist on the current historical workspace. It can be used to populate an enumeration of historical markers that have been created.

Product Availability

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

Returns:
A reference to a com.esri.arcgis.geodatabase.IEnumHistoricalMarker
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addHistoricalMarker

IHistoricalMarker addHistoricalMarker(String name,
                                      Object tstamp)
                                      throws IOException,
                                             AutomationException
Add a historical marker to this workspace.

Remarks

The AddHistoricalMarker method is used to add a historical marker to the workspace. Historical markers are used to represent specific moments in the database which reference a date and time. They can then be used as a mechanism to easily recognize specific database's moment or events.

For example, an organization might create historical markers to reflect quarters of a fiscal year. This will then allow users the ability to quickly change their historical versions to each moment using a historical marker.

Historical markers are case sensitive.

All users have privileges to create historical markers. Historical markers are limited to sixty-four characters. Adding a historical marker inserts a row into the gdb_historicalmarkers table and explicitly performs a database commit.

Product Availability

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

Parameters:
name - The name (in)
tstamp - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IHistoricalMarker
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeHistoricalMarker

void removeHistoricalMarker(String name)
                            throws IOException,
                                   AutomationException
Remove a historical marker from this workspace.

Remarks

The RemoveHistoricalMarker method removes the specified historical marker from the workspace.

All users have privileges to remove any historical marker. Removing a historical marker deletes the marker from the gdb_historicalmarkers table and explicitly performs a database commit.

The DEFAULT historical marker can not be deleted.

Product Availability

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

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

findHistoricalVersionByTimeStamp

IHistoricalVersion findHistoricalVersionByTimeStamp(Object tstamp)
                                                    throws IOException,
                                                           AutomationException
Open a historical version by specifying a timestamp.

Remarks

The FindHistoricalVersionByTimeStamp method can be used to find a specific historical version that exists in the historical workspace by specifying the time stamp.

Product Availability

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

Parameters:
tstamp - A Variant (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IHistoricalVersion
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findHistoricalVersionByName

IHistoricalVersion findHistoricalVersionByName(String historicalMarkerName)
                                               throws IOException,
                                                      AutomationException
Open a historical version by specifying a historical marker name.

Remarks

The FindHistoricalVersionByName method can be used to find a historical version by using an existing historical marker. The input string used to locate the historical marker is case sensitive. The "DEFAULT" historical marker is unique and is not case sensitive.

Product Availability

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

Parameters:
historicalMarkerName - The historicalMarkerName (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IHistoricalVersion
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.