com.esri.arcgis.geodatabase
Class ArchiveRegistrationInfo

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

All Implemented Interfaces:

IArchiveRegistrationInfo, java.io.Serializable

public class ArchiveRegistrationInfo

extends java.lang.Object

implements 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(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
java.lang.String	getArchiveTableName() The name of the archive table.
IArchiveRegistrationInfo	getAsIArchiveRegistrationInfo() Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.
static java.lang.String	getClsid()
java.lang.String	getDatasetName() The name of the dataset this registration information applies to.
java.lang.String	getFromFieldName() The name of the FROM field.
java.lang.String	getOIDFieldName() The name of the archive object id field.
java.lang.Object	getSeedTimeStamp() The initial timestamp when archiving was enabled.
java.lang.String	getToFieldName() The name of the TO field.
int	hashCode() the hashcode for this object
void	setArchiveTableName(java.lang.String archiveTableName) The name of the archive table.
void	setDatasetName(java.lang.String name) The name of the dataset this registration information applies to.
void	setFromFieldName(java.lang.String fromField) The name of the FROM field.
void	setOIDFieldName(java.lang.String oidField) The name of the archive object id field.
void	setToFieldName(java.lang.String toField) The name of the TO field.

Methods inherited from class java.lang.Object

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

Constructor Detail

ArchiveRegistrationInfo

public ArchiveRegistrationInfo()
                        throws java.io.IOException,
                               java.net.UnknownHostException

Constructs a ArchiveRegistrationInfo using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

ArchiveRegistrationInfo

public ArchiveRegistrationInfo(java.lang.Object obj)
                        throws java.io.IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.

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.
ArchiveRegistrationInfo theArchiveRegistrationInfo = (ArchiveRegistrationInfo) obj;

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getAsIArchiveRegistrationInfo

public IArchiveRegistrationInfo getAsIArchiveRegistrationInfo()

Deprecated. No replacement. The object reference can be directly used where the implemented interface is needed.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

hashCode

public int hashCode()

the hashcode for this object

getDatasetName

public java.lang.String getDatasetName()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IArchiveRegistrationInfo

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.

Specified by:

getDatasetName in interface IArchiveRegistrationInfo

Returns:

The name

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDatasetName

public void setDatasetName(java.lang.String name)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IArchiveRegistrationInfo

The name of the dataset this registration information applies to.

Specified by:

setDatasetName in interface IArchiveRegistrationInfo

Parameters:

name - The name (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getArchiveTableName

public java.lang.String getArchiveTableName()
                                     throws java.io.IOException,
                                            AutomationException

Description copied from interface: IArchiveRegistrationInfo

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

Specified by:

getArchiveTableName in interface IArchiveRegistrationInfo

Returns:

The archiveTableName

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setArchiveTableName

public void setArchiveTableName(java.lang.String archiveTableName)
                         throws java.io.IOException,
                                AutomationException

Description copied from interface: IArchiveRegistrationInfo

The name of the archive table.

Specified by:

setArchiveTableName in interface IArchiveRegistrationInfo

Parameters:

archiveTableName - The archiveTableName (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getFromFieldName

public java.lang.String getFromFieldName()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IArchiveRegistrationInfo

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

Specified by:

getFromFieldName in interface IArchiveRegistrationInfo

Returns:

The fromField

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setFromFieldName

public void setFromFieldName(java.lang.String fromField)
                      throws java.io.IOException,
                             AutomationException

Description copied from interface: IArchiveRegistrationInfo

The name of the FROM field.

Specified by:

setFromFieldName in interface IArchiveRegistrationInfo

Parameters:

fromField - The fromField (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getToFieldName

public java.lang.String getToFieldName()
                                throws java.io.IOException,
                                       AutomationException

Description copied from interface: IArchiveRegistrationInfo

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

Specified by:

getToFieldName in interface IArchiveRegistrationInfo

Returns:

The toField

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

setToFieldName

public void setToFieldName(java.lang.String toField)
                    throws java.io.IOException,
                           AutomationException

Description copied from interface: IArchiveRegistrationInfo

The name of the TO field.

Specified by:

setToFieldName in interface IArchiveRegistrationInfo

Parameters:

toField - The toField (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getOIDFieldName

public java.lang.String getOIDFieldName()
                                 throws java.io.IOException,
                                        AutomationException

Description copied from interface: IArchiveRegistrationInfo

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

Specified by:

getOIDFieldName in interface IArchiveRegistrationInfo

Returns:

The oidField

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOIDFieldName

public void setOIDFieldName(java.lang.String oidField)
                     throws java.io.IOException,
                            AutomationException

Description copied from interface: IArchiveRegistrationInfo

The name of the archive object id field.

Specified by:

setOIDFieldName in interface IArchiveRegistrationInfo

Parameters:

oidField - The oidField (in)

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.

getSeedTimeStamp

public java.lang.Object getSeedTimeStamp()
                                  throws java.io.IOException,
                                         AutomationException

Description copied from interface: IArchiveRegistrationInfo

The initial timestamp when archiving was enabled.

Specified by:

getSeedTimeStamp in interface IArchiveRegistrationInfo

Returns:

A Variant

Throws:

AutomationException - If the ArcObject component throws an exception.

java.io.IOException - If there are interop problems.