com.esri.arcgis.geodatabase
Interface IArchiveRegistrationInfo

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArchiveRegistrationInfo

public interface IArchiveRegistrationInfo
extends Serializable

The properties used to register a dataset for archiving and for describing an already registered object.

Description

The EnableArchiving method takes a set of ArchiveRegistrationInfo objects. The IArchiveRegistrationInfo interface can be leveraged to define the archive registration configuration. The interface contains four read/write properties which define the customization. The DatasetName property refers to the name of the dataset this registration info object applies to. The ArchiveTableName property specifies the name of the archive table that will be created by the registration process. The FromFieldName and ToFieldName properties specify the historical schema for the archive table.

Remarks

It is important to note that unless there is an entry in the set for each archive object a default schema setup will be used during the time of registration.

Product Availability

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

Method Summary

String	getArchiveTableName() The name of the archive table.
String	getDatasetName() The name of the dataset this registration information applies to.
String	getFromFieldName() The name of the FROM field.
String	getOIDFieldName() The name of the archive object id field.
Object	getSeedTimeStamp() The initial timestamp when archiving was enabled.
String	getToFieldName() The name of the TO field.
void	setArchiveTableName(String archiveTableName) The name of the archive table.
void	setDatasetName(String name) The name of the dataset this registration information applies to.
void	setFromFieldName(String fromField) The name of the FROM field.
void	setOIDFieldName(String oidField) The name of the archive object id field.
void	setToFieldName(String toField) The name of the TO field.

Method Detail

getDatasetName

String getDatasetName()
                      throws IOException,
                             AutomationException

The name of the dataset this registration information applies to.

Remarks

The DatasetName property refers to the name of the dataset the registration info object applies to. This property is used as an identifier when the dataset is registered for archiving.

Product Availability

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

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetName

void setDatasetName(String name)
                    throws IOException,
                           AutomationException

The name of the dataset this registration information applies to.

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.

getArchiveTableName

String getArchiveTableName()
                           throws IOException,
                                  AutomationException

The name of the archive table.

Remarks

The ArchiveTableName property is used to specify a table's name for the archive table that is created when a dataset is registered for archiving. If no name is specified through the ArchiveTableName property the name will default to the object name appended with an "_H", for example "PARCELS_H".

Product Availability

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

Returns:

The archiveTableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArchiveTableName

void setArchiveTableName(String archiveTableName)
                         throws IOException,
                                AutomationException

The name of the archive table.

Product Availability

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

Parameters:

archiveTableName - The archiveTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromFieldName

String getFromFieldName()
                        throws IOException,
                               AutomationException

The name of the FROM field.

Remarks

The FromFieldName property is used to specify the field name for the from date field in the archive table. If no user defined name is specified the field name will default to "GDB_FROM_DATE".

Product Availability

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

Returns:

The fromField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromFieldName

void setFromFieldName(String fromField)
                      throws IOException,
                             AutomationException

The name of the FROM field.

Product Availability

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

Parameters:

fromField - The fromField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToFieldName

String getToFieldName()
                      throws IOException,
                             AutomationException

The name of the TO field.

Remarks

The ToFieldName property is used to specify the field name for the to date field in the archive table. If no user defined name is specified the field name will default to "GDB_TO_DATE".

Product Availability

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

Returns:

The toField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToFieldName

void setToFieldName(String toField)
                    throws IOException,
                           AutomationException

The name of the TO field.

Product Availability

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

Parameters:

toField - The toField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

String getOIDFieldName()
                       throws IOException,
                              AutomationException

The name of the archive object id field.

Remarks

The OIDFieldName property is used to specify the field name for the archive object identifier field which is a unique field that is maintained in the archive table. If no user defined name is specified the field name will default to "GDB_ARCHIVE_OID".

Product Availability

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

Returns:

The oidField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOIDFieldName

void setOIDFieldName(String oidField)
                     throws IOException,
                            AutomationException

The name of the archive object id field.

Product Availability

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

Parameters:

oidField - The oidField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeedTimeStamp

Object getSeedTimeStamp()
                        throws IOException,
                               AutomationException

The initial timestamp when archiving was enabled.

Product Availability

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

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.