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

All Known Implementing Classes:

DefaultXObjectDocument, XWikiApplication

public interface XObjectDocument

SuperDocument interface.

Since:

Application Manager 1.0RC1

Version:

$Id$

See Also:

XClassManager

Field Summary

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

Method Summary

Document	getDocumentApi()
Object	getObjectApi()
int	getObjectId()
XClassManager<? extends XObjectDocument>	getXClassManager()
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 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 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.

getXClassManager

XClassManager<? extends XObjectDocument> getXClassManager()

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

Document getDocumentApi()

Returns:

the document.

getObjectApi

Object getObjectApi()

Returns:

the managed XWiki object.

getObjectId

int getObjectId()

Returns:

the id of the managed XWiki object;