org.hudsonci.maven.plugin.documents
Interface DocumentManager

All Known Implementing Classes:

DocumentManagerImpl

public interface DocumentManager

Provides access to configuration documents.

Since:

2.1.0

Author:

Jason Dillon

Method Summary

DocumentDTO	addDocument(DocumentDTO document) Add a document to the document store.
DocumentDTO	getDocument(String id, boolean summary)
Collection<DocumentDTO>	getDocuments(boolean summary)
Collection<DocumentDTO>	getDocuments(DocumentTypeDTO type, boolean summary)
void	removeDocument(String id)
DocumentDTO	updateDocument(DocumentDTO document) Update the specified document by id.

Method Detail

getDocuments

Collection<DocumentDTO> getDocuments(boolean summary)

getDocuments

Collection<DocumentDTO> getDocuments(DocumentTypeDTO type,
                                     boolean summary)

addDocument

DocumentDTO addDocument(DocumentDTO document)

Add a document to the document store.

Parameters:

document - the document to add

Returns:

a summary of the document added

getDocument

DocumentDTO getDocument(String id,
                        boolean summary)

updateDocument

DocumentDTO updateDocument(DocumentDTO document)

Update the specified document by id.

Parameters:

document -

Returns:

a summary of the updated document

removeDocument

void removeDocument(String id)