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

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArchiveRecordFactoryImpl

public interface ArchiveRecordFactory
extends Serializable

Method Summary

ArchiveRecord	generateArchiveRecordFrom(Object currentDocument) This method is used to generate the archive record from the current document model.
Class<ArchiveRecord>	getArchiveRecordClass() This method returns the class this factory will instantiate.

Method Detail

getArchiveRecordClass

Class<ArchiveRecord> getArchiveRecordClass()

This method returns the class this factory will instantiate.

Returns:

- an ArchiveRecord class definition.

generateArchiveRecordFrom

ArchiveRecord generateArchiveRecordFrom(Object currentDocument)
                                        throws Exception

This method is used to generate the archive record from the current document model.

Parameters:

currentDocument - -the current document instance

Returns:

an archive record instance populated with information from the current document model.

Throws:

Exception