Interface "Data Archive Provider"
Exposes an interface for Data Archive. Data Archive is called from application objects to store data.
Methods
Create
Creates a new archive entry.
procedure Create(Description: Text): IntegerParameters
| Name | Type | Description |
|---|---|---|
| Description | Text |
The name or description for the archive entry. Will typically be the calling object name. |
Returns
| Type | Description |
|---|---|
| Integer |
The entry no. of the created archive entry - if any. |
Open
Opens an existing archive entry.
procedure Open(ID: Integer)Parameters
| Name | Type | Description |
|---|---|---|
| ID | Integer |
The ID of the archive entry. |
Save
Saves and closes the currently open archive entry.
procedure Save()DiscardChanges
Discards any additions and closes the currently open archive entry.
procedure DiscardChanges()SaveRecord
Saves the supplied record to the currently open archive entry.
procedure SaveRecord(var RecordRef: RecordRef)Parameters
| Name | Type | Description |
|---|---|---|
| RecordRef | RecordRef |
The record will be copied to the archive. |
SaveRecord
Saves the supplied record to the currently open archive entry.
procedure SaveRecord(RecordVar: Variant)Parameters
| Name | Type | Description |
|---|---|---|
| RecordVar | Variant |
The record will be copied to the archive. |
SaveRecords
Saves all records within the filters to the currently open archive entry.
procedure SaveRecords(var RecordRef: RecordRef)Parameters
| Name | Type | Description |
|---|---|---|
| RecordRef | RecordRef |
All records for the RecRef within the filters will be copied to the archive. |
StartSubscriptionToDelete
Starts subscription to the OnDatabaseDelete trigger and calls SaveRecord with any deleted record.
procedure StartSubscriptionToDelete()StartSubscriptionToDelete
Starts subscription to the OnDatabaseDelete trigger and calls SaveRecord with any deleted record.
procedure StartSubscriptionToDelete(ResetSession: Boolean)Parameters
| Name | Type | Description |
|---|---|---|
| ResetSession | Boolean |
If true, then the session will be reset. This can be necessary if a deletion has already been made on any table that should be archived. |
StopSubscriptionToDelete
Stops the subscription to the OnDatabaseDelete trigger.
procedure StopSubscriptionToDelete()DataArchiveProviderExists
Informs the consumer app whether there is a provider for this interface.
procedure DataArchiveProviderExists(): BooleanReturns
| Type | Description |
|---|---|
| Boolean |
Returns true if a provider for this interface is installed. |
SetDataArchiveProvider
Sets the instance of the provider. Needed for self-reference.
procedure SetDataArchiveProvider(var NewDataArchiveProvider: Interface "Data Archive Provider")Parameters
| Name | Type | Description |
|---|---|---|
| NewDataArchiveProvider | Interface System.DataAdministration."Data Archive Provider" |
The global instance of IDataArchiveProvider. |