org.nuxeo.ecm.platform.archive.api
Interface ArchiveManager

All Superinterfaces:

Serializable

All Known Subinterfaces:

ArchiveManagerLocal

All Known Implementing Classes:

ArchiveManagerBean

public interface ArchiveManager
extends Serializable

Archives manager interface.

:XXX: http://jira.nuxeo.org/browse/NXP-514

Author:

Bogdan Tatar

Method Summary

void	addArchiveRecord(ArchiveRecord record)
Boolean	deleteArchiveRecord(long recordId)
void	editArchiveRecord(ArchiveRecord record)
ArchiveRecord	findArchiveRecordById(long archiveRecordId) Returns the archive record object with the specified id.
List<ArchiveRecord>	findArchiveRecords(String qlString, Map<String,Object> parameters) Returns the archive records matched by the specified JPA query.
List<ArchiveRecord>	getArchiveRecordsByDocUID(String docUID) Returns the archive records of a document by giving the doc uid.
ArchiveRecord	searchArchiveRecord()

Method Detail

getArchiveRecordsByDocUID

List<ArchiveRecord> getArchiveRecordsByDocUID(String docUID)
                                              throws Exception

Returns the archive records of a document by giving the doc uid.

Parameters:

docUID - the document UID

Returns:

a list of archive records attached to the document

Throws:

Exception

findArchiveRecordById

ArchiveRecord findArchiveRecordById(long archiveRecordId)
                                    throws Exception

Returns the archive record object with the specified id.

Parameters:

archiveRecordId - the id of the archive record

Returns:

the archive record with the specified id

Throws:

Exception

findArchiveRecords

List<ArchiveRecord> findArchiveRecords(String qlString,
                                       Map<String,Object> parameters)

Returns the archive records matched by the specified JPA query. The parameters map provides the named parameters and values to be set on the query.

Parameters:

qlString - the query to execute

parameters - the named parameters to be set on the query

Returns:

searchArchiveRecord

ArchiveRecord searchArchiveRecord()
                                  throws Exception

Returns:

Throws:

Exception

addArchiveRecord

void addArchiveRecord(ArchiveRecord record)
                      throws Exception

Parameters:

record - : the archive record info to be added

Throws:

Exception

editArchiveRecord

void editArchiveRecord(ArchiveRecord record)
                       throws Exception

Parameters:

record - : the archive record to edit

Throws:

Exception

deleteArchiveRecord

Boolean deleteArchiveRecord(long recordId)
                            throws Exception

Parameters:

record - : the archive record to delete

Throws:

Exception