---

Document Class Reference

#include <Document.h>

Inheritance diagram for Document:

List of all members.

Public Methods
	Document ()
NumID	addRevision (Revision revision)
DocumentError	removeRevision (NumID id)
DocumentError	getRevision (NumID id, Revision &revision)
vector< NumID >	listRevisions ()
DocumentError	addRendition (NumID revid, string mimetype, NumID fileid)
string	toXML () const
DocumentError	fromXML (const string &str)

---

Detailed Description

XML-based document information (metadata, revisions) class.

---

Constructor & Destructor Documentation

Document::Document (    )

Constructor.

---

Member Function Documentation

DocumentError Document::addRendition (  NumID    revid, string    mimetype, NumID    fileid )

Add rendition to revision. Parameters: revid  the revision mimetype  the MIME type for the rendition fileid  the file ID of the rendition (file)

NumID Document::addRevision (  Revision    revision )

Add revision. Parameters: revision  the revision to add Returns: the new revision ID

DocumentError Document::fromXML (  const string &    str )  [virtual]

Read document information from XML. Parameters: str  the XML for this document information Implements AbstractDocument.

DocumentError Document::getRevision (  NumID    id, Revision &    revision )

Get revision. Parameters: id  the revision ID revision  the revision reference to return value

vector< NumID > Document::listRevisions (    )

Get the list of revisions for this document. Returns: a list of revision IDs

DocumentError Document::removeRevision (  NumID    id )

Remove revision. Parameters: id  the ID of the revision to remove

string Document::toXML (    )  [virtual]

Returns an XML representation of the document information. Implements AbstractDocument.

---

The documentation for this class was generated from the following files:

• Document.h
• Document.cpp

---