sfi.director.application.autodoc.DocExtDocu Class Reference

List of all members.

---

Detailed Description

Handles external documents.

Public Member Functions
	DocExtDocu (DBObject docdef)
	DocExtDocu (String urn)
void	store () throws DirectorException
	Store the current object meta information in the database.
DBObject	toDBObject ()
boolean	isInclude ()
boolean	isInline ()
String	categoryName ()
	Accessor for attribute categoryName.
String	categoryName (String categoryName)
	Mutator for attribute categoryName.
String	caption ()
	Accessor for attribute caption.
String	caption (String caption)
	Mutator for attribute caption.
String	file ()
	Accessor for attribute file.
String	file (String file)
	Mutator for attribute file.
String	urn ()
	Accessor for attribute urn.
String	urn (String urn)
	Mutator for attribute urn.
String	read () throws DirectorException
	returns the document text
void	fetch () throws DirectorException
Static Public Member Functions
static DocExtDocu	retrieve (String urn) throws DirectorException
static String	mangledUrn (String urn)
static String	unmangledUrn (String mangled)
Protected Attributes
String	categoryName = null
	The document's category.
String	caption = null
	The document title.
String	file = null
	The document file.
String	urn = null
	The URN associated with this document.
Static Package Attributes
static Cache	handlerCache = new Cache()

---

Constructor & Destructor Documentation

sfi.director.application.autodoc.DocExtDocu.DocExtDocu (  DBObject  docdef  )

sfi.director.application.autodoc.DocExtDocu.DocExtDocu (  String  urn  )

---

Member Function Documentation

String sfi.director.application.autodoc.DocExtDocu.caption (  String  caption  )

Mutator for attribute caption. The document title.

String sfi.director.application.autodoc.DocExtDocu.caption (   )

Accessor for attribute caption. The document title.

String sfi.director.application.autodoc.DocExtDocu.categoryName (  String  categoryName  )

Mutator for attribute categoryName. The document's category.

String sfi.director.application.autodoc.DocExtDocu.categoryName (   )

Accessor for attribute categoryName. The document's category.

void sfi.director.application.autodoc.DocExtDocu.fetch (   )  throws DirectorException

String sfi.director.application.autodoc.DocExtDocu.file (  String  file  )

Mutator for attribute file. The document file.

String sfi.director.application.autodoc.DocExtDocu.file (   )

Accessor for attribute file. The document file.

boolean sfi.director.application.autodoc.DocExtDocu.isInclude (   )

boolean sfi.director.application.autodoc.DocExtDocu.isInline (   )

static String sfi.director.application.autodoc.DocExtDocu.mangledUrn (  String  urn  )  [static]

String sfi.director.application.autodoc.DocExtDocu.read (   )  throws DirectorException

returns the document text

static DocExtDocu sfi.director.application.autodoc.DocExtDocu.retrieve (  String  urn  )  throws DirectorException [static]

void sfi.director.application.autodoc.DocExtDocu.store (   )  throws DirectorException

Store the current object meta information in the database.

DBObject sfi.director.application.autodoc.DocExtDocu.toDBObject (   )

static String sfi.director.application.autodoc.DocExtDocu.unmangledUrn (  String  mangled  )  [static]

String sfi.director.application.autodoc.DocExtDocu.urn (  String  urn  )

Mutator for attribute urn. The URN associated with this document.

String sfi.director.application.autodoc.DocExtDocu.urn (   )

Accessor for attribute urn. The URN associated with this document.

---

Member Data Documentation

String sfi.director.application.autodoc.DocExtDocu.caption = null [protected]

The document title.

String sfi.director.application.autodoc.DocExtDocu.categoryName = null [protected]

The document's category.

String sfi.director.application.autodoc.DocExtDocu.file = null [protected]

The document file.

Cache sfi.director.application.autodoc.DocExtDocu.handlerCache = new Cache() [static, package]

String sfi.director.application.autodoc.DocExtDocu.urn = null [protected]

The URN associated with this document.

---

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

• director/application/autodoc/DocExtDocu.java

---