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

Modifier and Type	Method and Description
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.
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	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).

getVersionLabel

String getVersionLabel(DocumentModel document)

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.