ArchiveManager

Method Summary
int	cancelArchives(String[] archiveIds) Cancels the scheduled archives and returns the number of successful results.
boolean	deleteArchive(String archiveId) Deletes the archive record and remote file.
Archive	getArchive(String archiveId) Returns the archive specified by archiveId.
SystemDataView	getArchiveView() Returns a view for accessing transactions that have been archived.
SystemDataView	getScheduledArchiveView() Returns a view for accessing transactions that are scheduled for archiving.
boolean	isSystemArchiveEnabled() Returns true if this enterprise has system archive enabled
boolean	scheduleArchive(Date date, Packet packet) Schedules the selected transaction packet for archive using the system storage provider. The enterprise must be enabled by the cloud owner for this feature to work. See isSystemArchiveEnabled. Test transactions not allowed.
boolean	scheduleArchive(StorageProvider provider, Date date, Packet packet) Schedules the selected transaction packet for archive using the specified storage provider.
int	scheduleArchives(Date date, String[] txIds) Schedules the selected transactions for archive using the system storage provider. See isSystemArchiveEnabled. Test transactions not allowed.
int	scheduleArchives(StorageProvider provider, Date date, String[] txIds) Schedules the selected transactions for archive using the specified storage provider.
String	toString() Returns a description of this object.

Method Detail

int cancelArchives(String[] archiveIds)

Cancels the scheduled archives and returns the number of successful results.

Parameters:

String[] archiveIds - array of one or more archive ids, maximum 100 entries.

Returns: int

Since: 02-29-2012

top

boolean deleteArchive(String archiveId)

Deletes the archive record and remote file.

Parameters:

String archiveId

Returns: boolean

Since: 02-29-2012

top

Archive getArchive(String archiveId)

Returns the archive specified by archiveId.

Parameters:

String archiveId

Returns: Archive

Since: 03-01-2012

top

SystemDataView getArchiveView()

Returns a view for accessing transactions that have been archived.

Returns: SystemDataView

DataList Name: Archive

DataList Keys/Column Name	Column Type	Read Only
id	String
txId	String
name	String
description	String
category	String
status	String
createDate	Date
archiveDate	Date
txSize	Medium integer
softArchive	Boolean
securedTx	Boolean
testTx	Boolean
column1	String
column2	String
column3	String
column4	String
palId	String

Since: 02-29-2012

top

SystemDataView getScheduledArchiveView()

Returns a view for accessing transactions that are scheduled for archiving.

Returns: SystemDataView

DataList Name: ScheduledArchive

DataList Keys/Column Name	Column Type	Read Only
name	String
securedTxStatus	String
description	String
category	String
createDate	Date
modifiedDate	Date
securedTx	Boolean
testTx	Boolean
status	String
softArchive	Boolean
webServiceStatus	String
palId	String
consoleControlled	Boolean
column1	String
column2	String
column3	String
column4	String
executeEndDate	Date
accessEndDate	Date
archiveEndDate	Date
archiveDate	Date
txSize	Number
id	String
error	Boolean
errorMessage	String
archiveDate	Date
txId	String

Since: 02-29-2012

top

boolean isSystemArchiveEnabled()

Returns true if this enterprise has system archive enabled

Returns: boolean

Since: 03-01-2012

top

boolean scheduleArchive(Date date, Packet packet)

Schedules the selected transaction packet for archive using the system storage provider. The enterprise must be enabled by the cloud owner for this feature to work. See isSystemArchiveEnabled. Test transactions not allowed.

Parameters:

Date date Required parameter.
Packet packet

Returns: boolean

Since: 03-01-2012

top

boolean scheduleArchive(StorageProvider provider, Date date, Packet packet)

Schedules the selected transaction packet for archive using the specified storage provider.

Parameters:

StorageProvider provider Required parameter.
Date date Required parameter.
Packet packet

Returns: boolean

Since: 02-29-2012

top

int scheduleArchives(Date date, String[] txIds)

Schedules the selected transactions for archive using the system storage provider. See isSystemArchiveEnabled. Test transactions not allowed.

Parameters:

Date date Required parameter.
String[] txIds - array of one or more transaction ids, maximum 100 entries.

Returns: int

Since: 03-01-2012

top

int scheduleArchives(StorageProvider provider, Date date, String[] txIds)

Schedules the selected transactions for archive using the specified storage provider.

Parameters:

StorageProvider provider Required parameter.
Date date Required parameter.
String[] txIds - array of one or more transaction ids, maximum 100 entries.

Returns: int

Since: 02-29-2012

top

String toString()

Returns a description of this object.

Returns: String

Since: 02-29-2012

top

API Date: Nov 18, 2024 01:04 PM