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
String	factoryForIncrementationRules()
boolean	factoryForRenderVersioningOption()
Map<String,String>	getAvailableVersioningOptionsMap()
boolean	getCreateSnapshot() Deprecated. since 5.4
Collection<VersionModel>	getCurrentItemVersioningHistory() Returns the available versioning history for the current document and state.
Collection<VersioningActions>	getCurrentItemVersioningOptions() Deprecated. since 5.4
boolean	getDefaultCreateSnapshot() Deprecated. since 5.4
boolean	getDisplayCreateSnapshotOption() Deprecated. since 5.4
String	getIncRulesResult() Deprecated. since 5.4
Collection<VersionModel>	getItemVersioningHistory(DocumentModel document) Returns the available versioning options for the document parameter and state.
String	getVersioningOptionInstanceId()
Map<String,String>	getVersioningOptionsMap(DocumentModel documentModel) Deprecated. since 5.4
String	getVersionLabel(DocumentModel document)
void	setCreateSnapshot(boolean createSnapshot) Deprecated. since 5.4
void	setVersioningOptionInstanceId(DocumentModel document, String optionId)
void	setVersioningOptionInstanceId(DocumentModel document, VersioningActions option)
void	setVersioningOptionInstanceId(String optionId) Web action method to set version increment option to the current documentModel.
void	validateOptionSelection(FacesContext context, UIComponent component, Object value) Versioning increment options - select radio component validator method.

Method Detail

getIncRulesResult

@Deprecated
String getIncRulesResult()

Deprecated. since 5.4

Provides an explaining message of the inc options availability.

Returns:

key for the message (to be read from messages bundles)

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.

getCurrentItemVersioningOptions

Collection<VersioningActions> getCurrentItemVersioningOptions()

Deprecated. since 5.4

Returns the available versioning options for the currentItem and state.

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

@Deprecated
Map<String,String> getVersioningOptionsMap(DocumentModel documentModel)

Deprecated. since 5.4

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

getAvailableVersioningOptionsMap

Map<String,String> getAvailableVersioningOptionsMap()

getVersionLabel

String getVersionLabel(DocumentModel document)
                       throws ClientException

Throws:

ClientException

getVersioningOptionInstanceId

String getVersioningOptionInstanceId()

factoryForIncrementationRules

String factoryForIncrementationRules()

factoryForRenderVersioningOption

boolean factoryForRenderVersioningOption()

setVersioningOptionInstanceId

void setVersioningOptionInstanceId(String optionId)
                                   throws ClientException

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

Throws:

ClientException

setVersioningOptionInstanceId

void setVersioningOptionInstanceId(DocumentModel document,
                                 String optionId)
                                   throws ClientException

Throws:

ClientException

setVersioningOptionInstanceId

void setVersioningOptionInstanceId(DocumentModel document,
                                 VersioningActions option)
                                   throws ClientException

Throws:

ClientException

validateOptionSelection

void validateOptionSelection(FacesContext context,
                           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.

setCreateSnapshot

@Deprecated
void setCreateSnapshot(boolean createSnapshot)

Deprecated. since 5.4

getCreateSnapshot

@Deprecated
boolean getCreateSnapshot()
                          throws ClientException

Deprecated. since 5.4

Throws:

ClientException

getDefaultCreateSnapshot

@Deprecated
boolean getDefaultCreateSnapshot()
                                 throws ClientException

Deprecated. since 5.4

Throws:

ClientException

getDisplayCreateSnapshotOption

@Deprecated
boolean getDisplayCreateSnapshotOption()
                                       throws ClientException

Deprecated. since 5.4

Throws:

ClientException