tmozIDocument Interface Reference

Document. More...

List of all members.

Public Member Functions
boolean	hasAttribute (in AString name)
	Check if document has given attribute.
AString	getAttribute (in AString name)
	Return value of given attribute.
boolean	isModified ()
	Check if document is modified Function check if document is modified.
void	setAttribute (in AString name, in AString value)
	Set attribute.
void	commit ()
	Commit changes to the repository.
tmozIPage	addPage (in AString filePath, in AString mimeType)
	Add page to the document.

---

Detailed Description

Document.

Object represent document stored in the repository (tmozIDocumentRepository).

---

Member Function Documentation

tmozIPage addPage	(	in AString	filePath,
		in AString	mimeType
	)

Add page to the document.

Parameters:

	filePath	Path to the source file
	mimeType	MimeType of the file

Returns:

Return new page. Throw exception if failed.

AString getAttribute

(

in AString

name

)

Return value of given attribute.

Function return value of the attribute.

Parameters:

name

Name of the attribute.

Returns:

Return value of the attribute.

Note:

Function throws exception if attribute does not exist.

boolean hasAttribute

(

in AString

name

)

Check if document has given attribute.

Function check if attribute has attribute.

Parameters:

name

Name of the attribute.

Returns:

Return true if document has attribute. Return false if document has not attribute.

boolean isModified

(

)

Check if document is modified Function check if document is modified.

Returns:

Return true if document is modified. Return false if document is not modified.

Note:

New document is always marked as modified.

void setAttribute	(	in AString	name,
		in AString	value
	)

Set attribute.

Parameters:

	name	Name of attribute
	value	Value of attribue