org.apache.jetspeed.page.document
Interface DocumentHandler

public interface DocumentHandler

DocumentHandler

Version:

$Id: DocumentHandler.java 721971 2008-12-01 05:44:52Z rwatler $

Author:

Scott T. Weaver

Method Summary

Document	getDocument(java.lang.String name)
Document	getDocument(java.lang.String name, boolean fromCahe)
DocumentHandlerFactory	getHandlerFactory()
java.lang.String	getType()
void	removeDocument(Document document)
void	setHandlerFactory(DocumentHandlerFactory factory)
void	shutdown() shutdown - gracefully shutdown handler and disconnect from other singleton components, (e.g.
void	updateDocument(Document document)

Method Detail

getDocument

Document getDocument(java.lang.String name)
                     throws DocumentNotFoundException,
                            NodeException

Throws:

DocumentNotFoundException

NodeException

getDocument

Document getDocument(java.lang.String name,
                     boolean fromCahe)
                     throws DocumentNotFoundException,
                            NodeException

Throws:

DocumentNotFoundException

NodeException

updateDocument

void updateDocument(Document document)
                    throws FailedToUpdateDocumentException

Throws:

FailedToUpdateDocumentException

removeDocument

void removeDocument(Document document)
                    throws DocumentNotFoundException,
                           FailedToDeleteDocumentException

Throws:

DocumentNotFoundException

FailedToDeleteDocumentException

getType

java.lang.String getType()

getHandlerFactory

DocumentHandlerFactory getHandlerFactory()

setHandlerFactory

void setHandlerFactory(DocumentHandlerFactory factory)

shutdown

void shutdown()

shutdown - gracefully shutdown handler and disconnect from other singleton components, (e.g. shared caches)