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

Methods

Modifier and Type	Method and Description
Document	getDocument(String name)
Document	getDocument(String name, boolean fromCahe)
DocumentHandlerFactory	getHandlerFactory()
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(String name)
                     throws DocumentNotFoundException,
                            NodeException

Throws:

DocumentNotFoundException

NodeException

getDocument

Document getDocument(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

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)