com.esri.arcgis.geodatabase
Class ArchiveRegistrationInfo

java.lang.Object
  com.esri.arcgis.geodatabase.ArchiveRegistrationInfo

All Implemented Interfaces:

IArchiveRegistrationInfo, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class ArchiveRegistrationInfo
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArchiveRegistrationInfo

Product Availability

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

See Also:

Serialized Form

Constructor Summary

ArchiveRegistrationInfo()
Constructs a ArchiveRegistrationInfo using ArcGIS Engine.

ArchiveRegistrationInfo(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArchiveRegistrationInfo theArchiveRegistrationInfo = (ArchiveRegistrationInfo) obj;

Method Summary

boolean	equals(Object o) Compare this object with another
String	getArchiveTableName() The name of the archive table.
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArchiveRegistrationInfo

public ArchiveRegistrationInfo()
                        throws IOException,
                               UnknownHostException

Constructs a ArchiveRegistrationInfo using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArchiveRegistrationInfo

public ArchiveRegistrationInfo(Object obj)
                        throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArchiveRegistrationInfo theArchiveRegistrationInfo = (ArchiveRegistrationInfo) obj;

Construct a ArchiveRegistrationInfo using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArchiveRegistrationInfo.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getDatasetName

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

Specified by:

getDatasetName in interface IArchiveRegistrationInfo

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetName

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

Specified by:

setDatasetName in interface IArchiveRegistrationInfo

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArchiveTableName

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

Specified by:

getArchiveTableName in interface IArchiveRegistrationInfo

Returns:

The archiveTableName

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setArchiveTableName

public void setArchiveTableName(String archiveTableName)
                         throws IOException,
                                AutomationException

The name of the archive table.

Product Availability

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

Specified by:

setArchiveTableName in interface IArchiveRegistrationInfo

Parameters:

archiveTableName - The archiveTableName (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFromFieldName

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

Specified by:

getFromFieldName in interface IArchiveRegistrationInfo

Returns:

The fromField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFromFieldName

public void setFromFieldName(String fromField)
                      throws IOException,
                             AutomationException

The name of the FROM field.

Product Availability

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

Specified by:

setFromFieldName in interface IArchiveRegistrationInfo

Parameters:

fromField - The fromField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToFieldName

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

Specified by:

getToFieldName in interface IArchiveRegistrationInfo

Returns:

The toField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToFieldName

public void setToFieldName(String toField)
                    throws IOException,
                           AutomationException

The name of the TO field.

Product Availability

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

Specified by:

setToFieldName in interface IArchiveRegistrationInfo

Parameters:

toField - The toField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOIDFieldName

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

Specified by:

getOIDFieldName in interface IArchiveRegistrationInfo

Returns:

The oidField

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOIDFieldName

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

Specified by:

setOIDFieldName in interface IArchiveRegistrationInfo

Parameters:

oidField - The oidField (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSeedTimeStamp

public Object getSeedTimeStamp()
                        throws IOException,
                               AutomationException

The initial timestamp when archiving was enabled.

Product Availability

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

Specified by:

getSeedTimeStamp in interface IArchiveRegistrationInfo

Returns:

A Variant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.