com.xpn.xwiki.plugin.applicationmanager.core.doc.objects.classes
Interface SuperDocument

All Known Implementing Classes:

DefaultSuperDocument, XWikiApplication

public interface SuperDocument

SuperDocument interface.

Version:

$Id: $

See Also:

SuperClass

Field Summary

static java.lang.String	SPACE_DOC_SEPARATOR The separator between space name and document name in document full name.
static java.lang.String	WIKI_SPACE_SEPARATOR The separator between wiki name and space name and document extended full name.

Method Summary

com.xpn.xwiki.api.Document	getDocumentApi()
com.xpn.xwiki.api.Object	getObjectApi()
int	getObjectId()
SuperClass	getSuperClass()
boolean	isNew()
void	reload(com.xpn.xwiki.XWikiContext context) Reload XWiki document from database using Document full name.

Field Detail

SPACE_DOC_SEPARATOR

static final java.lang.String SPACE_DOC_SEPARATOR

The separator between space name and document name in document full name.

See Also:

Constant Field Values

WIKI_SPACE_SEPARATOR

static final java.lang.String WIKI_SPACE_SEPARATOR

The separator between wiki name and space name and document extended full name.

See Also:

Constant Field Values

Method Detail

reload

void reload(com.xpn.xwiki.XWikiContext context)
            throws com.xpn.xwiki.XWikiException

Reload XWiki document from database using Document full name.

Parameters:

context - the XWiki context.

Throws:

com.xpn.xwiki.XWikiException - error when initialize document.

getSuperClass

SuperClass getSuperClass()

Returns:

the class manager for this document.

isNew

boolean isNew()

Returns:

true if this is a new document of this class (this document can exist but does not contains object of this class).

getDocumentApi

com.xpn.xwiki.api.Document getDocumentApi()

Returns:

the document.

getObjectApi

com.xpn.xwiki.api.Object getObjectApi()

Returns:

the managed XWiki object.

getObjectId

int getObjectId()

Returns:

the id of the managed XWiki object;