oracle.ifs.fdk

Interface ArchiveManager

All Superinterfaces:

Remote

All Known Implementing Classes:

ArchiveManagerImpl, CoreArchiveManager

public interface ArchiveManager
extends Remote

Archive Manager interface for handling archive related operations.

Performs the following operations.

1. Obtain archive from a domain id.
2. Empty Archive
3. Purge items that beyond their cut-off period
4. Delete a document from archive

Method Summary

Modifier and Type	Method and Description
void	emptyArchive(long archiveId) Empties a given Archive.
Item	restoreFromArchive(long archiveId, long sourceId, NamedValue[] options) Restores a document/folder specified by sourceId into the location specified by DESTFOLDER option from the Archive.
void	setArchiveConfiguration(long archiveId, NamedValue[] attributes) Sets the Archive configuration.

Method Detail

emptyArchive

void emptyArchive(long archiveId)
           throws FdkException

Empties a given Archive.

Parameters:

archiveId - The Id of archive to be emptied

Throws:

FdkException - If the operation fails

setArchiveConfiguration

void setArchiveConfiguration(long archiveId,
                             NamedValue[] attributes)
                      throws FdkException

Sets the Archive configuration.

Parameters:

archiveId - the Archive for which to set the configuration

attributes - the Archive configuration options to set; must include one or more of the following Attributes:

• notation: {Attribute name, Attribute type}
• {Attributes.ARCHIVE_ENABLED, Boolean}
• {Attributes.ARCHIVE_AUTO_EMPTY_ENABLED, Boolean}
• {Attributes.ARCHIVE_MIN_HOLDING_PERIOD, Long}

Throws:

FdkException - if the operation fails.

restoreFromArchive

Item restoreFromArchive(long archiveId,
                        long sourceId,
                        NamedValue[] options)
                 throws FdkException

Restores a document/folder specified by sourceId into the location specified by DESTFOLDER option from the Archive.

Parameters:

archiveId - The Archive

sourceId - The document to be restored

options - The attributes specified for restore,such as destination folder

• notation: {Attribute name, Attribute type}
• {Attributes.NAME, String}
• {Options.DESTFOLDER, Long}
• {Options.OVERWRITE, Boolean}
• {Options.UNIQUENAME, Boolean}
• {Options.NEWVERSION, Boolean}
• {Options.RESPECT_NULL_RESOURCE_LOCKS, Boolean}

Returns:

The restored item

Throws:

FdkException - If the operation fails