tmozIDocumentRepository Interface Reference

Document repository. More...

List of all members.

Public Member Functions
tmozIDocumentRepositoryLock	lockRepository ()
	Lock repository.
nsISimpleEnumerator	createDocumentIterator (in tmozIDocumentRepositoryLock lock)
	Create document iterator.
void	destroyDocumentIterator (in tmozIDocumentRepositoryLock lock, in nsISimpleEnumerator iter)
	Destroy document iterator.
tmozIDocument	createDocument (in tmozIDocumentRepositoryLock lock, in AString docType)
	Create document in repository.
boolean	removeDocument (in tmozIDocumentRepositoryLock lock, in tmozIDocument document)
	Remove document from the repository.
Public Attributes
readonly attribute tmozIDocumentTypes	documentTypes
	Document types manager.
readonly attribute tmozIPresentationManager	presentationManager
	Presentation manager.

---

Detailed Description

Document repository.

Object provides access to the document repository. It is possible to iterate over stored documents, remove them, etc.

Pseudo code to access repository:

 var reposComp = this.domain.componentManager.get("Core.Repository");;
 var rqs = reposComp.QueryInterface(Components.interfaces.nsIInterfaceRequestor);
 var repos = rqs.getInterface(Components.interfaces.tmozIDocumentRepository);

---

Member Function Documentation

tmozIDocument createDocument	(	in tmozIDocumentRepositoryLock	lock,
		in AString	docType
	)

Create document in repository.

Parameters:

document

Created document

nsISimpleEnumerator createDocumentIterator

(

in tmozIDocumentRepositoryLock

lock

)

Create document iterator.

Iterator allows to iterate over all documents in the repository. Iterator should be closed using destroyDocumentIterator.

Parameters:

lock

Current repository lock

Returns:

Return new iterator

void destroyDocumentIterator	(	in tmozIDocumentRepositoryLock	lock,
		in nsISimpleEnumerator	iter
	)

Destroy document iterator.

Function invalidates document iterator.

Parameters:

	lock	Current repository lock
	iter	Iterator to be invalidated.

tmozIDocumentRepositoryLock lockRepository

(

)

Lock repository.

Method lock repository. It returns newly created lock. To unlock repository returned object have to be destroyed or method unlock() can be called.

Returns:

Return lock object.

boolean removeDocument	(	in tmozIDocumentRepositoryLock	lock,
		in tmozIDocument	document
	)

Remove document from the repository.

Function remove document from the repository.

Parameters:

	lock	Current repository lock
	document	Document to be removed.

Returns:

Return true if document was removed. Return false if document was not removed.

---

Member Data Documentation

readonly attribute tmozIDocumentTypes documentTypes

Document types manager.

Manager of document types

readonly attribute tmozIPresentationManager presentationManager

Presentation manager.

Presentation manager can be used to enumerate all available presentations, add or remove presentation.