org.nuxeo.ecm.webapp.versioning

Interface DocumentVersioning

All Known Implementing Classes:

DocumentVersioningBean

public interface DocumentVersioning

Web action listener interface for versioning.

Author:

Dragos Mihalache

Method Summary

Methods

Modifier and Type	Method and Description
boolean	factoryForRenderVersioningOption() Deprecated. since 5.7.3: rendered clause for available versioning options are resolved by the widget now
Map<String,String>	getAvailableVersioningOptionsMap() Deprecated. since 5.7.3: available versioning options are resolved by the widget now
Collection<VersionModel>	getCurrentItemVersioningHistory() Returns the available versioning history for the current document and state.
Collection<VersionModel>	getItemVersioningHistory(DocumentModel document) Returns the available versioning options for the document parameter and state.
String	getVersioningOptionInstanceId() Deprecated. since 5.7.3: selected option is not kept on this bean anymore, it's kept by the JSF component behind widget definition
Map<String,String>	getVersioningOptionsMap(DocumentModel documentModel) Creates a Map with versioning options (as keys) and labels (as map entry values).
String	getVersionLabel(DocumentModel document)
void	setVersioningOptionInstanceId(DocumentModel document, String optionId) Deprecated. since 5.7.3: document context map is now filled directly by the widget
void	setVersioningOptionInstanceId(DocumentModel document, VersioningActions option) Deprecated. since 5.7.3: document context map is now filled directly by the widget
void	setVersioningOptionInstanceId(String optionId) Deprecated. since 5.7.3: document context map is now filled directly by the widget
void	validateOptionSelection(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value) Versioning increment options - select radio component validator method.

Method Detail

getItemVersioningHistory

Collection<VersionModel> getItemVersioningHistory(DocumentModel document)

Returns the available versioning options for the document parameter and state.

Parameters:

document - the document for which the versioning options will be returned

Returns:

a collection of option names.

getCurrentItemVersioningHistory

Collection<VersionModel> getCurrentItemVersioningHistory()

Returns the available versioning history for the current document and state.

Returns:

a collection of option names.

getVersioningOptionsMap

Map<String,String> getVersioningOptionsMap(DocumentModel documentModel)

Creates a Map with versioning options (as keys) and labels (as map entry values).

getAvailableVersioningOptionsMap

@Deprecated
Map<String,String> getAvailableVersioningOptionsMap()

Deprecated. since 5.7.3: available versioning options are resolved by the widget now

getVersionLabel

String getVersionLabel(DocumentModel document)
                       throws ClientException

Throws:

ClientException

getVersioningOptionInstanceId

@Deprecated
String getVersioningOptionInstanceId()

Deprecated. since 5.7.3: selected option is not kept on this bean anymore, it's kept by the JSF component behind widget definition

factoryForRenderVersioningOption

@Deprecated
boolean factoryForRenderVersioningOption()

Deprecated. since 5.7.3: rendered clause for available versioning options are resolved by the widget now

setVersioningOptionInstanceId

@Deprecated
void setVersioningOptionInstanceId(String optionId)
                                   throws ClientException

Deprecated. since 5.7.3: document context map is now filled directly by the widget

Web action method to set version increment option to the current documentModel.

Throws:

ClientException

setVersioningOptionInstanceId

@Deprecated
void setVersioningOptionInstanceId(DocumentModel document,
                                            String optionId)
                                   throws ClientException

Deprecated. since 5.7.3: document context map is now filled directly by the widget

Throws:

ClientException

setVersioningOptionInstanceId

@Deprecated
void setVersioningOptionInstanceId(DocumentModel document,
                                            VersioningActions option)
                                   throws ClientException

Deprecated. since 5.7.3: document context map is now filled directly by the widget

Throws:

ClientException

validateOptionSelection

void validateOptionSelection(javax.faces.context.FacesContext context,
                           javax.faces.component.UIComponent component,
                           Object value)

Versioning increment options - select radio component validator method. Check if an option has been selected. This is mandatory since the component is being displayed.