VersionedActions (Nuxeo ECM Projects 10.1 API)

All Known Implementing Classes:

VersionedActionsBean
```
public interface VersionedActions
```
Exposes the actions that can be taken related to versioning and documents.

Author:

Razvan Caraghin, Florent Guillaume

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`canRemoveArchivedVersion(VersionModel selectedVersion)` Check if a version can be removed.
`String`	`checkIn()` Checks the selected document in, with the selected version.
`String`	`checkOut()` Checks the document out.
`boolean`	`getCanRemoveSelectedArchivedVersions()` Check if the currently selected versions can be removed.
`boolean`	`getCanRestore()` Security check to enable or disable the restore button.
`String`	`getCheckedOut()` Tells if the current selected document is checked out or not.
`String`	`getSelectedVersionId()` Gets currently selected version id.
`DocumentModel`	`getSourceDocument()`
`DocumentModel`	`getSourceDocument(DocumentModel document)`
`PageSelections<VersionModel>`	`getVersionList()` Factory accessor for currentDocument versionList.
`void`	`initialize()`
`String`	`removeArchivedVersion(VersionModel selectedVersion)` Remove an archived version.
`String`	`removeSelectedArchivedVersions()` Remove currently selected archived versions.
`void`	`resetVersions()` When the user selects/changes other documents then we nullify the list of versions associated with the document so that the factory method gets called when the list is used.
`String`	`restoreToVersion()` Restores the version which id is returned by `getSelectedVersionId()`.
`String`	`restoreToVersion(VersionModel selectedVersion)` Restored the document to the selected version.
`void`	`retrieveVersions()` Retrieves the versions for the current document.
`void`	`setCheckedOut(String checkedOut)` Changes the checked-out string.
`void`	`setSelectedVersionId(String selectedVersionId)` Sets currently selected version id.
`String`	`viewArchivedVersion()` Navigates to the version which id is returned by `getSelectedVersionId()`.
`String`	`viewArchivedVersion(VersionModel selectedVersion)` View an older version of the document.

- Method Detail
  - getVersionList
```
PageSelections<VersionModel> getVersionList()
```
    Factory accessor for currentDocument versionList.
    
    Returns:
    
    the selected version list as a PageSelections
  - retrieveVersions
```
void retrieveVersions()
```
    Retrieves the versions for the current document.
  - restoreToVersion
```
String restoreToVersion(VersionModel selectedVersion)
```
    Restored the document to the selected version. If there is no selected version it does nothing.
    
    Returns:
    
    the page that needs to be displayed next
  - restoreToVersion
```
String restoreToVersion()
```
    Restores the version which id is returned by getSelectedVersionId().
    
    Returns:
    
    the view id
    
    Since:
    
    5.6
  - getCanRestore
```
boolean getCanRestore()
```
    Security check to enable or disable the restore button.
    
    Returns:
    
    permission check result
  - getCheckedOut
```
String getCheckedOut()
```
    Tells if the current selected document is checked out or not.
  - setCheckedOut
```
void setCheckedOut(String checkedOut)
```
    Changes the checked-out string.
    
    Parameters:
    
    checkedOut -
  - checkOut
```
String checkOut()
```
    Checks the document out.
    
    Returns:
    
    the next page
  - checkIn
```
String checkIn()
```
    Checks the selected document in, with the selected version.
  - initialize
```
@Create
void initialize()
```
  - resetVersions
```
void resetVersions()
```
    When the user selects/changes other documents then we nullify the list of versions associated with the document so that the factory method gets called when the list is used.
    This way we achieve lazy loading of data from backend - only when its needed and not loading it when the event is fired.
  - viewArchivedVersion
```
String viewArchivedVersion(VersionModel selectedVersion)
```
    View an older version of the document.
  - viewArchivedVersion
```
String viewArchivedVersion()
```
    Navigates to the version which id is returned by getSelectedVersionId().
    
    Returns:
    
    the view id
    
    Since:
    
    5.6
  - getSourceDocument
```
DocumentModel getSourceDocument()
```
  - getSourceDocument
```
DocumentModel getSourceDocument(DocumentModel document)
```
  - canRemoveArchivedVersion
```
boolean canRemoveArchivedVersion(VersionModel selectedVersion)
```
    Check if a version can be removed. It won't be possible if a proxy is pointing to it.
  - getCanRemoveSelectedArchivedVersions
```
boolean getCanRemoveSelectedArchivedVersions()
```
    Check if the currently selected versions can be removed. It won't be possible if a proxy is pointing to one of them.
    
    Returns:
    
    true if can remove selected archived versions
    
    Since:
    
    5.6
  - removeArchivedVersion
```
String removeArchivedVersion(VersionModel selectedVersion)
```
    Remove an archived version.
    
    Parameters:
    
    selectedVersion - the version model to remove
  - removeSelectedArchivedVersions
```
String removeSelectedArchivedVersions()
```
    Remove currently selected archived versions.
    
    Since:
    
    5.6
  - getSelectedVersionId
```
String getSelectedVersionId()
```
    Gets currently selected version id.
    
    Since:
    
    5.6
  - setSelectedVersionId
```
void setSelectedVersionId(String selectedVersionId)
```
    Sets currently selected version id.
    
    Since:
    
    5.6

Interface VersionedActions

Method Summary

Method Detail

getVersionList

retrieveVersions

restoreToVersion

restoreToVersion

getCanRestore

getCheckedOut

setCheckedOut

checkOut

checkIn

initialize

resetVersions

viewArchivedVersion

viewArchivedVersion

getSourceDocument

getSourceDocument

canRemoveArchivedVersion

getCanRemoveSelectedArchivedVersions

removeArchivedVersion

removeSelectedArchivedVersions

getSelectedVersionId

setSelectedVersionId