org.nuxeo.ecm.webapp.versioning

Class DocumentVersioningBean

java.lang.Object

org.nuxeo.ecm.webapp.versioning.DocumentVersioningBean

All Implemented Interfaces:

Serializable, DocumentVersioning

@Name(value="documentVersioning")
 @Scope(value=CONVERSATION)
 @Install(precedence=10)
public class DocumentVersioningBean
extends Object
implements DocumentVersioning, Serializable

Web action bean for document versioning. Used also by other seam components through injection.

Author:

Dragos Mihalache

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,String>	availableVersioningOptionsMap Deprecated. since 5.7.3: versioning options map does not need to be kept in cache anymore here
protected CoreSession	documentManager
protected NavigationContext	navigationContext
protected ResourcesAccessor	resourcesAccessor

Constructor Summary

Constructors

Constructor and Description
DocumentVersioningBean()

Method Summary

Modifier and Type	Method and Description
boolean	factoryForRenderVersioningOption() Deprecated.
VersionIncEditOptions	getAvailableVersioningOptions(DocumentModel doc)
Map<String,String>	getAvailableVersioningOptionsMap() Deprecated.
VersionInfo	getCurrentDocumentVersionInfo()
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.
boolean	getRendered() Deprecated. since 5.7.3: rendered clause is now evaluated on the widget definition instead
String	getVersioningOptionInstanceId() Deprecated.
Map<String,String>	getVersioningOptionsMap(DocumentModel doc) Creates a Map with versioning options (as keys) and labels (as map entry values).
String	getVersionLabel(DocumentModel doc)
void	resetVersioningOption()
void	setRendered(Boolean rendered) Deprecated. since 5.7.3: rendered clause is now evaluated on the widget definition instead
void	setVersioningOptionInstanceId(DocumentModel docModel, String optionId) Deprecated.
void	setVersioningOptionInstanceId(DocumentModel docModel, VersioningActions option) Deprecated.
void	setVersioningOptionInstanceId(String optionId) Deprecated.
void	validateOptionSelection(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value) Versioning increment options - select radio component validator method.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

resourcesAccessor

@In(create=true)
protected transient ResourcesAccessor resourcesAccessor

documentManager

@In(create=true,
    required=false)
protected transient CoreSession documentManager

availableVersioningOptionsMap

@Deprecated
protected Map<String,String> availableVersioningOptionsMap

Deprecated. since 5.7.3: versioning options map does not need to be kept in cache anymore here

navigationContext

@In(create=true)
protected transient NavigationContext navigationContext

Constructor Detail

DocumentVersioningBean

public DocumentVersioningBean()

Method Detail

getItemVersioningHistory

public Collection<VersionModel> getItemVersioningHistory(DocumentModel document)

Description copied from interface: DocumentVersioning

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

Specified by:

getItemVersioningHistory in interface DocumentVersioning

Parameters:

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

Returns:

a collection of option names.

getCurrentItemVersioningHistory

public Collection<VersionModel> getCurrentItemVersioningHistory()

Description copied from interface: DocumentVersioning

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

Specified by:

getCurrentItemVersioningHistory in interface DocumentVersioning

Returns:

a collection of option names.

getCurrentDocumentVersionInfo

@Factory(autoCreate=true,
         value="currentDocumentVersionInfo",
         scope=EVENT)
public VersionInfo getCurrentDocumentVersionInfo()

resetVersioningOption

@Observer(value={"documentSelectionChanged","documentChanged"},
          create=false)
 @BypassInterceptors
public void resetVersioningOption()

getAvailableVersioningOptionsMap

@Deprecated
public Map<String,String> getAvailableVersioningOptionsMap()

Deprecated.

Specified by:

getAvailableVersioningOptionsMap in interface DocumentVersioning

getVersioningOptionsMap

public Map<String,String> getVersioningOptionsMap(DocumentModel doc)

Description copied from interface: DocumentVersioning

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

Specified by:

getVersioningOptionsMap in interface DocumentVersioning

getAvailableVersioningOptions

public VersionIncEditOptions getAvailableVersioningOptions(DocumentModel doc)

getVersionLabel

public String getVersionLabel(DocumentModel doc)

Specified by:

getVersionLabel in interface DocumentVersioning

getVersioningOptionInstanceId

@Deprecated
public String getVersioningOptionInstanceId()

Deprecated.

Specified by:

getVersioningOptionInstanceId in interface DocumentVersioning

setVersioningOptionInstanceId

@Deprecated
public void setVersioningOptionInstanceId(String optionId)

Deprecated.

Description copied from interface: DocumentVersioning

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

Specified by:

setVersioningOptionInstanceId in interface DocumentVersioning

setVersioningOptionInstanceId

@Deprecated
public void setVersioningOptionInstanceId(DocumentModel docModel,
                                                      String optionId)

Deprecated.

Specified by:

setVersioningOptionInstanceId in interface DocumentVersioning

setVersioningOptionInstanceId

@Deprecated
public void setVersioningOptionInstanceId(DocumentModel docModel,
                                                      VersioningActions option)

Deprecated.

Specified by:

setVersioningOptionInstanceId in interface DocumentVersioning

validateOptionSelection

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

Description copied from interface: DocumentVersioning

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

Specified by:

validateOptionSelection in interface DocumentVersioning

factoryForRenderVersioningOption

@Deprecated
 @Factory(value="renderVersioningOptionsForCurrentDocument",
         scope=EVENT)
public boolean factoryForRenderVersioningOption()

Deprecated.

Specified by:

factoryForRenderVersioningOption in interface DocumentVersioning

getRendered

@Deprecated
public boolean getRendered()

Deprecated. since 5.7.3: rendered clause is now evaluated on the widget definition instead

setRendered

@Deprecated
public void setRendered(Boolean rendered)

Deprecated. since 5.7.3: rendered clause is now evaluated on the widget definition instead