Package org.xwiki.sheet

Interface SheetManager

@Role
public interface SheetManager

Interface used to retrieve the list of sheets available for a given document.

Since:

3.2M3

Version:

$Id: efc1c19c877af1c11c30e792bf7cb5efcf29520e $

Method Summary

Modifier and Type	Method	Description
List<DocumentReference>	getSheets(DocumentModelBridge document, String action)	Returns the list of sheets available for a given XWiki document in the current execution context.
default boolean	isSheetForced()	Indicate if the sheet system should be used (instead of old edit modes and #include based dispay).

Method Detail

getSheets

List<DocumentReference> getSheets(DocumentModelBridge document,
                                  String action)

Returns the list of sheets available for a given XWiki document in the current execution context.

Note: We can't use a document reference because the document might have unsaved objects. The create forms usually display an unsaved document that has some objects attached.

If this method fails for some reason to retrieve the sheets it shound't throw an exception but return an empty list and log an appropriate warning message instead.

Parameters:

document - a XWiki document

action - the action for which to retrieve the list of sheets ('view', 'edit' etc.); you can pass null or an empty string as a substitute for any action

Returns:

the list of sheets available for the given document and the specified action; these are sheets designed to be displayed when the specified action is performed on the given document (e.g. view sheets, edit sheets etc.)

isSheetForced

default boolean isSheetForced()

Indicate if the sheet system should be used (instead of old edit modes and #include based dispay). Generally controlled using the URL sheet parameter;

Returns:

true if the sheet system should be used

Since:

10.9