com.esri.sde.sdk.client
Class SeArchive

java.lang.Object
  com.esri.sde.sdk.client.SeArchive

public class SeArchive
extends java.lang.Object

This class contains methods to query and manipulate archives.

Constructor Summary

SeArchive(SeConnection conn)

Method Summary

void	create() Creates an archive based on the information in this object.
void	delete(java.lang.String archivingTable) Deletes an archive based on the name of the archiving table.
java.lang.String	getArchivingTable() Returns this object's archiving table.
java.lang.String[]	getDateColumns() Returns this object's from and to column names for the history table.
java.lang.String	getHistoryTable() Returns this object's history table.
void	getInfoByArchivingTable(java.lang.String archivingTable) Fetches an archive based on the name of the archiving table.
void	getInfoByHistoryTable(java.lang.String historyTable) Fetches an archive based on the name of the history table.
java.lang.String	getRowidColumn() Returns this object's rowid column for the history table.
java.util.Date	getStartTime() Returns this object's start time.
void	setArchivingTable(java.lang.String archivingTable) Sets the this object's archiving table.
void	setDateColumns(java.lang.String fromDateName, java.lang.String toDateName) Sets this object's from and to column names for the history table.
void	setHistoryTable(java.lang.String historyTable) Sets this object's history table.
void	setRowidColumn(java.lang.String rowidColumn) Sets this object's rowid column for the history table.
void	setStartTime(java.util.Date startTime) Sets this object's start time.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SeArchive

public SeArchive(SeConnection conn)
          throws SeException

Throws:

SeException

Method Detail

getArchivingTable

public java.lang.String getArchivingTable()

Returns this object's archiving table. The archiving table is the business table that has archiving enabled.

Returns:

String archivingTable The business table with archiving enabled.

setArchivingTable

public void setArchivingTable(java.lang.String archivingTable)
                       throws SeException

Sets the this object's archiving table. The archiving table is the business table that has archiving enabled.

Parameters:

archivingTable - String The business table with archiving enabled.

Throws:

SeException

getDateColumns

public java.lang.String[] getDateColumns()

Returns this object's from and to column names for the history table.

Returns:

String[0] fromDateName The from column name.

setDateColumns

public void setDateColumns(java.lang.String fromDateName,
                           java.lang.String toDateName)
                    throws SeException

Sets this object's from and to column names for the history table.

Parameters:

fromDateName - String The from column name.

toDateName - String The to column name.

Throws:

SeException

getHistoryTable

public java.lang.String getHistoryTable()

Returns this object's history table.

Returns:

String historyTable The history table name.

setHistoryTable

public void setHistoryTable(java.lang.String historyTable)
                     throws SeException

Sets this object's history table. The history table is the target of an archiving table.

Parameters:

historyTable - String The history table name.

Throws:

SeException

getRowidColumn

public java.lang.String getRowidColumn()

Returns this object's rowid column for the history table.

Returns:

String rowidColumn The rowid column name.

setRowidColumn

public void setRowidColumn(java.lang.String rowidColumn)
                    throws SeException

Sets this object's rowid column for the history table.

Parameters:

rowidColumn - String The rowid column name.

Throws:

SeException

getStartTime

public java.util.Date getStartTime()

Returns this object's start time.

Returns:

Date startTime The start time of the archive.

setStartTime

public void setStartTime(java.util.Date startTime)
                  throws SeException

Sets this object's start time. This is the user-defined time where the table is said to have had archiving enabled.

Parameters:

startTime - Date The start_time of the archive.

Throws:

SeException

create

public void create()
            throws SeException

Creates an archive based on the information in this object. This means creating the history table, populating it, registering it, and creating any required side tables for layers, xml, etc. The archive itself is also registered in the sde_archives table.

Throws:

SeException

delete

public void delete(java.lang.String archivingTable)
            throws SeException

Deletes an archive based on the name of the archiving table.

Throws:

SeException

getInfoByArchivingTable

public void getInfoByArchivingTable(java.lang.String archivingTable)
                             throws SeException

Fetches an archive based on the name of the archiving table.

Throws:

SeException

getInfoByHistoryTable

public void getInfoByHistoryTable(java.lang.String historyTable)
                           throws SeException

Fetches an archive based on the name of the history table.

Throws:

SeException