com.xpn.xwiki.doc
Interface MandatoryDocumentInitializer


@Role
public interface MandatoryDocumentInitializer

Provide a document that should be initialized at startup and when creating new wiki.

The role hint should be the local (or absolute if it's supposed to be used only for a specific wiki) reference of the document so that I can easily be found.

Version:
$Id: 76def0dd326a5a13605ffd853a84ebc952760a91 $

Method Summary
 EntityReference getDocumentReference()
           
 boolean updateDocument(XWikiDocument document)
          Update the provided document according to the need.
 

Method Detail

getDocumentReference

EntityReference getDocumentReference()
Returns:
the reference of the document to update. Can be either local or absolute depending if the document is associated to a specific wiki or not

updateDocument

boolean updateDocument(XWikiDocument document)
Update the provided document according to the need.

Parameters:
document - the existing document to update
Returns:
true if the document has been modified, false otherwise


Copyright © 2004–2014 XWiki. All rights reserved.