org.alfresco.module.vti.handler

Interface VersionsServiceHandler

All Known Implementing Classes:

AlfrescoVersionsServiceHandler

public interface VersionsServiceHandler

Interface for the Versions web service handler. Note that Versioning in SharePoint and Alfresco will sometimes have different semantics. This interface works with SharePoint versioning, and it's up to the implementation to translate (where needed) to Alfresco style versioning.

Author:

Dmitry Lazurkin

Method Summary

Modifier and Type	Method and Description
List<DocumentVersionBean>	deleteAllVersions(String fileName) Deletes "all versions" of the specified file.
List<DocumentVersionBean>	deleteVersion(String fileName, String fileVersion) Deletes the specified file version
List<DocumentVersionBean>	getVersions(String fileName) Returns information about the versions of the specified file
boolean	isVersionable(String fileName) Is the specified file name a versioned file?
String	makeCurrentVersionURL(String host, String context, String dws, String fileName)
String	makeDocumentDetailsURL(String host, String context, String dws, String fileName)
String	makeVersionURL(String host, String context, String dws, DocumentVersionBean version)
List<DocumentVersionBean>	restoreVersion(String fileName, String fileVersion) Restores the specified file version

Method Detail

getVersions

List<DocumentVersionBean> getVersions(String fileName)
                               throws FileNotFoundException

Returns information about the versions of the specified file

Parameters:

fileName - A string that contains the site-relative URL of the file in the form Folder_Name/File_Name

Returns:

information about the versions of the specified file

Throws:

FileNotFoundException

restoreVersion

List<DocumentVersionBean> restoreVersion(String fileName,
                                         String fileVersion)

Restores the specified file version

Parameters:

fileName - site relative url to the file

fileVersion - file version to restore

Returns:

list of DocumentVersion beans

deleteVersion

List<DocumentVersionBean> deleteVersion(String fileName,
                                        String fileVersion)
                                 throws FileNotFoundException,
                                        VersionDoesNotExistException

Deletes the specified file version

Parameters:

fileName - site relative url to the file

fileVersion - file version to restore

Returns:

list of DocumentVersion beans

Throws:

FileNotFoundException

VersionDoesNotExistException

deleteAllVersions

List<DocumentVersionBean> deleteAllVersions(String fileName)
                                     throws FileNotFoundException

Deletes "all versions" of the specified file. This doesn't actually mean deleting the whole version history though, it means deleting all except the last "Published Version" (last major version), and the current version (if different).

Parameters:

fileName -

Returns:

DocumentVersionBean current document

Throws:

FileNotFoundException

isVersionable

boolean isVersionable(String fileName)

Is the specified file name a versioned file?

Parameters:

fileName -

Returns:

true if versionable, false otherwise.

makeCurrentVersionURL

String makeCurrentVersionURL(String host,
                             String context,
                             String dws,
                             String fileName)

makeVersionURL

String makeVersionURL(String host,
                      String context,
                      String dws,
                      DocumentVersionBean version)

makeDocumentDetailsURL

String makeDocumentDetailsURL(String host,
                              String context,
                              String dws,
                              String fileName)