ch.elexis.services
Interface IDocumentManager

All Known Implementing Classes:

DameDokumentverwaltung, DocumentManagement

public interface IDocumentManager

A Service acting as DocumentManagement must implement this Interfache

Author:

gerry

Method Summary

boolean	addCategory(java.lang.String categorie) Add a Categorie
java.lang.String	addDocument(IOpaqueDocument doc) Ad a document
java.lang.String[]	getCategories() List Categories for Documents
IOpaqueDocument	getDocument(java.lang.String id)
java.util.List<IOpaqueDocument>	listDocuments(java.lang.String patID, java.lang.String categoryMatch, java.lang.String titleMatch, java.lang.String keywordMatch, TimeSpan dateMatch, java.lang.String contentsMatch) Retrieve documents with matching criteria.
boolean	removeDocument(java.lang.String guid) remove and delete a document

Method Detail

getCategories

java.lang.String[] getCategories()

List Categories for Documents

addCategory

boolean addCategory(java.lang.String categorie)

Add a Categorie

addDocument

java.lang.String addDocument(IOpaqueDocument doc)
                             throws ElexisException

Ad a document

Parameters:

doc - The IDocument to add

Returns:

ID of the newly created internal representation

Throws:

ElexisException

removeDocument

boolean removeDocument(java.lang.String guid)

remove and delete a document

Parameters:

guid - the guid of the doucment to remove

Returns:

true on success

getDocument

IOpaqueDocument getDocument(java.lang.String id)

listDocuments

java.util.List<IOpaqueDocument> listDocuments(java.lang.String patID,
                                              java.lang.String categoryMatch,
                                              java.lang.String titleMatch,
                                              java.lang.String keywordMatch,
                                              TimeSpan dateMatch,
                                              java.lang.String contentsMatch)
                                              throws ElexisException

Retrieve documents with matching criteria. If a parameter is null, it will be considered as "any". If a String parameter is enclosed in slashes, it will be considered as regex: "/m[ae]h/" will match mah and meh, while "m[ae]h" will only match the literal string m[ae]h.

Parameters:

patID - The ID of the patient the documents belong to

categoryMatch - the category or categories to match

titleMatch - title

keywordMatch - keyword to find. Will match if at least one of the documents keywords match the parameter

dateMatch - match only documents woth dates within the given timespan

contentsMatch - find a match in the contents of the document. Note: This is not supported by all documentmanagers and it might be very inefficient! If the parameter is not null and the implementation does not support contentMatch, it throws an ElexisException EE_NOT_SUPPORTED.

Returns:

lust of all IDocuments matching the goven criteria

Throws:

ElexisException