Package org.dspace.versioning.service

Interface VersioningService

All Known Implementing Classes:

VersioningServiceImpl

public interface VersioningService

Author:

Fabio Bolognesi (fabio at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com)

Method Summary

Modifier and Type	Method	Description
Version	createNewVersion(Context c, Item itemId)
Version	createNewVersion(Context c, Item itemId, String summary)
Version	createNewVersion(Context context, VersionHistory history, Item item, String summary, Date date, int versionNumber)
Version	getVersion(Context c, int versionID)
Version	getVersion(Context c, Item item)
List<Version>	getVersionsByHistory(Context c, VersionHistory vh)	Returns all versions of a version history.
void	removeVersion(Context c, Item item)
void	removeVersion(Context c, Version version)
Version	restoreVersion(Context c, Version version)
Version	restoreVersion(Context c, Version version, String summary)
Version	updateVersion(Context c, Item itemId, String summary)

Method Detail

createNewVersion

Version createNewVersion(Context c,
                         Item itemId)

createNewVersion

Version createNewVersion(Context c,
                         Item itemId,
                         String summary)

getVersionsByHistory

List<Version> getVersionsByHistory(Context c,
                                   VersionHistory vh)
                            throws SQLException

Returns all versions of a version history. To keep version numbers stable we do not delete versions, we do only set the item, date, summary and eperson null. This methods returns only those versions that have an item assigned.

Parameters:

c - The relevant DSpace Context.

vh - version history

Returns:

All versions of a version history that have an item assigned.

Throws:

SQLException - An exception that provides information on a database access error or other errors.

removeVersion

void removeVersion(Context c,
                   Version version)
            throws SQLException

Throws:

SQLException

removeVersion

void removeVersion(Context c,
                   Item item)
            throws SQLException

Throws:

SQLException

getVersion

Version getVersion(Context c,
                   int versionID)
            throws SQLException

Throws:

SQLException

restoreVersion

Version restoreVersion(Context c,
                       Version version)

restoreVersion

Version restoreVersion(Context c,
                       Version version,
                       String summary)

updateVersion

Version updateVersion(Context c,
                      Item itemId,
                      String summary)
               throws SQLException

Throws:

SQLException

getVersion

Version getVersion(Context c,
                   Item item)
            throws SQLException

Throws:

SQLException

createNewVersion

Version createNewVersion(Context context,
                         VersionHistory history,
                         Item item,
                         String summary,
                         Date date,
                         int versionNumber)