com.esri.arcgis.geodatabase
Class IHistoricalWorkspaceProxy

java.lang.Object
  extended by com.esri.arcgis.interop.Dispatch
      extended by com.esri.arcgis.geodatabase.IHistoricalWorkspaceProxy
All Implemented Interfaces:
IHistoricalWorkspace, Externalizable, Serializable

public class IHistoricalWorkspaceProxy
extends com.esri.arcgis.interop.Dispatch
implements IHistoricalWorkspace, 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.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.esri.arcgis.interop.Dispatch
DISPATCH_METHOD, DISPATCH_PROPERTYGET, DISPATCH_PROPERTYPUT, DISPATCH_PROPERTYPUTREF, E
 
Constructor Summary
  IHistoricalWorkspaceProxy()
           
  IHistoricalWorkspaceProxy(Object obj)
           
protected IHistoricalWorkspaceProxy(Object obj, String iid)
           
 
Method Summary
 IHistoricalMarker addHistoricalMarker(String name, Object tstamp)
          Add a historical marker to this workspace.
 void addListener(String iidStr, Object theListener, Object theSource)
           
 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 readExternal(ObjectInput in)
           
 void removeHistoricalMarker(String name)
          Remove a historical marker from this workspace.
 void removeListener(String iidStr, Object theListener)
           
 void writeExternal(ObjectOutput out)
           
 
Methods inherited from class com.esri.arcgis.interop.Dispatch
bindUsingMoniker, constructVtblPosTable, convertToNative, cookieForListener, createDispatch, createObjrefMonikerDisplayName, equals, getActiveObject, getActiveObject, getDefaultProperty, getDispatchIdOfName, getLastErrorCode, getMtsObjectContext, getObjRef, getPropertyByName, getPropertyByName, getVtblPos, hashCode, initDispatch, invoke, invokeMethodByName, invokeMethodByName, invokeMethodByName, invokePropertyGetByName, invokePropertyPutByName, invokePropertyPutByRefByName, isNativeMode, isObjRef, queryInterface, release, setNativeMode, setPropertyByName, toString, vtblInvoke
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

IHistoricalWorkspaceProxy

public IHistoricalWorkspaceProxy()

IHistoricalWorkspaceProxy

public IHistoricalWorkspaceProxy(Object obj)
                          throws IOException
Throws:
IOException

IHistoricalWorkspaceProxy

protected IHistoricalWorkspaceProxy(Object obj,
                                    String iid)
                             throws IOException
Throws:
IOException
Method Detail

addListener

public void addListener(String iidStr,
                        Object theListener,
                        Object theSource)
                 throws IOException
Overrides:
addListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

removeListener

public void removeListener(String iidStr,
                           Object theListener)
                    throws IOException
Overrides:
removeListener in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

getDefaultMarkerName

public 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.

Specified by:
getDefaultMarkerName in interface IHistoricalWorkspace
Returns:
The defaultMarkerName
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHistoricalMarkers

public 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.

Specified by:
getHistoricalMarkers in interface IHistoricalWorkspace
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

public 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.

Specified by:
addHistoricalMarker in interface IHistoricalWorkspace
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

public 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.

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

findHistoricalVersionByTimeStamp

public 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.

Specified by:
findHistoricalVersionByTimeStamp in interface IHistoricalWorkspace
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

public 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.

Specified by:
findHistoricalVersionByName in interface IHistoricalWorkspace
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.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Overrides:
writeExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Overrides:
readExternal in class com.esri.arcgis.interop.Dispatch
Throws:
IOException
ClassNotFoundException