ch.elexis.text
Interface IOpaqueDocument

All Known Implementing Classes:

DocHandle, GenericDocument

public interface IOpaqueDocument

A Contract for a piece of Information in an arbitrary format - a document - that can be stored and retrieved in the system. The IOpaqueDocument holds the reference to the original contents and some metadata. The Interface has no means to analyze the contents of the document. thus Opaque.

Method Summary

java.lang.String	getCategory() Category of the document.
byte[]	getContentsAsBytes() A representation of the contents as byte array
java.io.InputStream	getContentsAsStream() A representation of the contents a stream
java.lang.String	getCreationDate() Date this document was created
java.lang.String	getGUID() A globally unique identifier for this document.
java.lang.String	getKeywords() Arbitrary keywords for this document
java.lang.String	getMimeType() Mime-Type of the contents.
Patient	getPatient() The Patient this document belongs to.
java.lang.String	getTitle() Title for the document.

Method Detail

getTitle

java.lang.String getTitle()

Title for the document. Not more than 80 characters. Must not be null and must not be empty

getMimeType

java.lang.String getMimeType()

Mime-Type of the contents.

Returns:

The MimeType (see rfc2045) of the document. May be null or empty if not known

getContentsAsStream

java.io.InputStream getContentsAsStream()
                                        throws ElexisException

A representation of the contents a stream

Returns:

an InpputStream

Throws:

ElexisException

getContentsAsBytes

byte[] getContentsAsBytes()
                          throws ElexisException

A representation of the contents as byte array

Returns:

a byte array with the original contents

Throws:

ElexisException

getKeywords

java.lang.String getKeywords()

Arbitrary keywords for this document

Returns:

null or empty or a list of keywords, separated by comma or space

getCategory

java.lang.String getCategory()

Category of the document. This is an arbitrary, user-defined String

Returns:

null or empty or the category for this document

getCreationDate

java.lang.String getCreationDate()

Date this document was created

Returns:

a date in ISO Format. Never null

getPatient

Patient getPatient()

The Patient this document belongs to.

Returns:

A Patient or null if the document does not belong to a patient.

getGUID

java.lang.String getGUID()

A globally unique identifier for this document. The implementation must ensure that (1) No two documents in the world ever exist with the same GUID, and (2) A document will always have the same GUID assigned within this application, i.e. the call getGUID on the same document will always return the same value.

Returns: