org.dspace.app.webui.util

Class VersionUtil

java.lang.Object

org.dspace.app.webui.util.VersionUtil

public class VersionUtil
extends java.lang.Object

Item level versioning feature utility method

Author:

Luigi Andrea Pascarelli

Constructor Summary

Constructors

Constructor and Description
VersionUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String[]	addItemIdentifier(Item item, Version version) Retrieve an array of string where in first position there is the path builded from the dc.identifier (e.g.
static Version	checkLatestVersion(Context context, Item item) Return the latest version, if there isn't or the user not have permission then return null.
static java.lang.String	getSummary(Context context, java.lang.String stringVersionID) Retrieve the summary for the version
static boolean	hasVersionHistory(Context context, Item item) Check if the item have a version history
static boolean	isItemInSubmission(Context context, Item item) Check item if it is in workspace or workflow
static boolean	isLatest(Context context, Item item) Check if the item is the last version builded
static java.lang.Integer	processCreateNewVersion(Context context, int itemID, java.lang.String summary) Create a new version of the specified item, otherwise return null
static java.lang.Integer	processDeleteVersions(Context context, int itemId, java.lang.String[] versionIDs) Delete version(s)
static void	processRestoreVersion(Context context, int versionID, java.lang.String summary) Restore a version
static void	processUpdateVersion(Context context, int itemID, java.lang.String summary) Modify latest version
static VersionHistory	retrieveVersionHistory(Context context, Item item) Retrieve the version history of the item

Methods inherited from class java.lang.Object

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

Constructor Detail

VersionUtil

public VersionUtil()

Method Detail

processCreateNewVersion

public static java.lang.Integer processCreateNewVersion(Context context,
                                        int itemID,
                                        java.lang.String summary)
                                                 throws java.sql.SQLException,
                                                        AuthorizeException,
                                                        java.io.IOException

Create a new version of the specified item, otherwise return null

Parameters:

context - The DSpace context

itemID - The id of the to-be-versioned item

summary - The motif of the versioning

Returns:

Integer

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

processUpdateVersion

public static void processUpdateVersion(Context context,
                        int itemID,
                        java.lang.String summary)
                                 throws java.sql.SQLException,
                                        AuthorizeException,
                                        java.io.IOException

Modify latest version

Parameters:

context - The DSpace context

itemID - The id of the to-be-versioned item

summary - The motif of the versioning

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

processRestoreVersion

public static void processRestoreVersion(Context context,
                         int versionID,
                         java.lang.String summary)
                                  throws java.sql.SQLException,
                                         AuthorizeException,
                                         java.io.IOException

Restore a version

Parameters:

versionID - id of the version to restore

context - The DSpace context

summary -

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

processDeleteVersions

public static java.lang.Integer processDeleteVersions(Context context,
                                      int itemId,
                                      java.lang.String[] versionIDs)
                                               throws java.sql.SQLException,
                                                      AuthorizeException,
                                                      java.io.IOException

Delete version(s)

Parameters:

context - The DSpace context

versionIDs - list of versionIDs to delete

itemId -

Returns:

latest version item id or null if all versions has been removed

Throws:

java.sql.SQLException

AuthorizeException

java.io.IOException

isLatest

public static boolean isLatest(Context context,
               Item item)

Check if the item is the last version builded

Parameters:

context -

item -

Returns:

true or false

hasVersionHistory

public static boolean hasVersionHistory(Context context,
                        Item item)

Check if the item have a version history

Parameters:

context -

item -

Returns:

true or false

checkLatestVersion

public static Version checkLatestVersion(Context context,
                         Item item)
                                  throws java.sql.SQLException

Return the latest version, if there isn't or the user not have permission then return null.

Parameters:

context -

item -

Returns:

the latest version of the item

Throws:

java.sql.SQLException

retrieveVersionHistory

public static VersionHistory retrieveVersionHistory(Context context,
                                    Item item)

Retrieve the version history of the item

Parameters:

context -

item -

Returns:

history

isItemInSubmission

public static boolean isItemInSubmission(Context context,
                         Item item)
                                  throws java.sql.SQLException

Check item if it is in workspace or workflow

Parameters:

context -

item -

Returns:

true if item is in workflow or workspace

Throws:

java.sql.SQLException

addItemIdentifier

public static java.lang.String[] addItemIdentifier(Item item,
                                   Version version)

Retrieve an array of string where in first position there is the path builded from the dc.identifier (e.g. //authority/path where path is /handle/123456789/1), in second position founded the value of dc.identifier

Parameters:

item -

version -

Returns:

array of string

getSummary

public static java.lang.String getSummary(Context context,
                          java.lang.String stringVersionID)

Retrieve the summary for the version

Parameters:

context -

stringVersionID -

Returns: