Package org.dspace.versioning.service

Interface VersionHistoryService

All Superinterfaces:

DSpaceCRUDService<VersionHistory>

All Known Implementing Classes:

VersionHistoryServiceImpl

public interface VersionHistoryService
extends DSpaceCRUDService<VersionHistory>

Author:

Fabio Bolognesi (fabio at atmire dot com), Mark Diggory (markd at atmire dot com), Ben Bosman (ben at atmire dot com), Pascal-Nicolas Becker (dspace at pascal dash becker dot de)

Method Summary

Modifier and Type	Method	Description
void	add(Context context, VersionHistory versionHistory, Version version)
boolean	canSeeDraftVersion(Context context, VersionHistory versionHistory)	This method has a scope to verify if the logged user has permission to see the attribute 'draftVersion' of the latest version.
VersionHistory	findByItem(Context context, Item item)
Version	getFirstVersion(Context context, VersionHistory versionHistory)
Version	getLatestVersion(Context context, VersionHistory versionHistory)
Version	getNext(Context context, VersionHistory versionHistory, Version version)
Version	getPrevious(Context context, VersionHistory versionHistory, Version version)
Version	getVersion(Context context, VersionHistory versionHistory, Item item)
boolean	hasNext(Context context, VersionHistory versionHistory, Item item)
boolean	hasNext(Context context, VersionHistory versionHistory, Version version)
boolean	hasVersionHistory(Context context, Item item)
boolean	isFirstVersion(Context context, Item item)
boolean	isFirstVersion(Context context, VersionHistory versionHistory, Version version)
boolean	isLastVersion(Context context, Item item)
boolean	isLastVersion(Context context, VersionHistory versionHistory, Version version)
void	remove(VersionHistory versionHistory, Version version)

Methods inherited from interface org.dspace.service.DSpaceCRUDService

create, delete, find, update, update

Method Detail

add

void add(Context context,
         VersionHistory versionHistory,
         Version version)
  throws SQLException

Throws:

SQLException

findByItem

VersionHistory findByItem(Context context,
                          Item item)
                   throws SQLException

Throws:

SQLException

getFirstVersion

Version getFirstVersion(Context context,
                        VersionHistory versionHistory)
                 throws SQLException

Throws:

SQLException

getLatestVersion

Version getLatestVersion(Context context,
                         VersionHistory versionHistory)
                  throws SQLException

Throws:

SQLException

getNext

Version getNext(Context context,
                VersionHistory versionHistory,
                Version version)
         throws SQLException

Throws:

SQLException

getPrevious

Version getPrevious(Context context,
                    VersionHistory versionHistory,
                    Version version)
             throws SQLException

Throws:

SQLException

getVersion

Version getVersion(Context context,
                   VersionHistory versionHistory,
                   Item item)
            throws SQLException

Throws:

SQLException

hasNext

boolean hasNext(Context context,
                VersionHistory versionHistory,
                Item item)
         throws SQLException

Throws:

SQLException

hasNext

boolean hasNext(Context context,
                VersionHistory versionHistory,
                Version version)
         throws SQLException

Throws:

SQLException

hasVersionHistory

boolean hasVersionHistory(Context context,
                          Item item)
                   throws SQLException

Throws:

SQLException

isFirstVersion

boolean isFirstVersion(Context context,
                       Item item)
                throws SQLException

Throws:

SQLException

isFirstVersion

boolean isFirstVersion(Context context,
                       VersionHistory versionHistory,
                       Version version)
                throws SQLException

Throws:

SQLException

isLastVersion

boolean isLastVersion(Context context,
                      Item item)
               throws SQLException

Throws:

SQLException

isLastVersion

boolean isLastVersion(Context context,
                      VersionHistory versionHistory,
                      Version version)
               throws SQLException

Throws:

SQLException

remove

void remove(VersionHistory versionHistory,
            Version version)

canSeeDraftVersion

boolean canSeeDraftVersion(Context context,
                           VersionHistory versionHistory)
                    throws SQLException

This method has a scope to verify if the logged user has permission to see the attribute 'draftVersion' of the latest version.

Parameters:

context - DSpace context object

versionHistory - Version history object

Returns:

return true if the logged user has permission to see the attribute 'draftVersion' of the latest version, otherwise false

Throws:

SQLException - If database error