org.apache.portals.graffito.services.dm
Interface DocumentModelService

public interface DocumentModelService

Document Model Service Interface

This service maintains Document & DocumentStream objects.

Version:

$Id: ContentModelService.java,v 1.1 2004/12/22 21:16:12 christophe Exp $

Author:

Christophe Lombart

Method Summary

void	addDocument(Document document) Adds a document to engine's persistent store.
Document	createDocument() Factory to create a new empty document object.
Document	getDocument(java.lang.String uri) Get a document from the engine's persistent store by uri.
Document	getDocument(java.lang.String uri, java.lang.String versionNum) Get a document from the engine's persistent store by uri.
void	removeDocument(Document document) Remove a document from the engine's persistent store.
void	updateDocument(Document document) Update a document in the engine's persistent store.

Method Detail

addDocument

void addDocument(Document document)
                 throws ContentManagementException

Adds a document to engine's persistent store.

Parameters:

document - the document to add

Throws:

ContentManagementException

createDocument

Document createDocument()
                        throws ContentManagementException

Factory to create a new empty document object.

Returns:

an empty factory created document

Throws:

ContentManagementException

getDocument

Document getDocument(java.lang.String uri)
                     throws ContentManagementException

Get a document from the engine's persistent store by uri. This methods returns the lastes version.

Parameters:

uri - uri assigned to the document.

Returns:

Document found or null

Throws:

ContentManagementException

getDocument

Document getDocument(java.lang.String uri,
                     java.lang.String versionNum)
                     throws ContentManagementException

Get a document from the engine's persistent store by uri.

Parameters:

uri - uri assigned to the document.

versionNum - the desired version number assigned to the document to retrieve

Returns:

Document found or null

Throws:

ContentManagementException

removeDocument

void removeDocument(Document document)
                    throws ContentManagementException

Remove a document from the engine's persistent store.

Parameters:

document - the document to remove.

Throws:

ContentManagementException

updateDocument

void updateDocument(Document document)
                    throws ContentManagementException

Update a document in the engine's persistent store.

Parameters:

document - the document to update.

Throws:

ContentManagementException