Package org.dspace.access.status

Interface AccessStatusHelper

All Known Implementing Classes:

DefaultAccessStatusHelper

public interface AccessStatusHelper

Plugin interface for the access status calculation.

Method Summary

Modifier and Type	Method	Description
AccessStatus	getAccessStatusFromBitstream(Context context, Bitstream bitstream, LocalDate threshold, String type)	Calculate the access status for the bitstream.
AccessStatus	getAccessStatusFromItem(Context context, Item item, LocalDate threshold, String type)	Calculate the access status for the item.
AccessStatus	getAnonymousAccessStatusFromItem(Context context, Item item, LocalDate threshold)	Calculate the anonymous access status for the item.

Method Details

getAccessStatusFromItem

AccessStatus getAccessStatusFromItem(Context context,
 Item item,
 LocalDate threshold,
 String type)
                              throws SQLException

Calculate the access status for the item.

Parameters:

context - the DSpace context

item - the item

threshold - the embargo threshold date

type - the type of calculation

Returns:

the access status

Throws:

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

getAnonymousAccessStatusFromItem

AccessStatus getAnonymousAccessStatusFromItem(Context context,
 Item item,
 LocalDate threshold)
                                       throws SQLException

Calculate the anonymous access status for the item.

Parameters:

context - the DSpace context

item - the item to check for embargo information

threshold - the embargo threshold date

Returns:

the access status

Throws:

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

getAccessStatusFromBitstream

AccessStatus getAccessStatusFromBitstream(Context context,
 Bitstream bitstream,
 LocalDate threshold,
 String type)
                                   throws SQLException

Calculate the access status for the bitstream.

Parameters:

context - the DSpace context

bitstream - the bitstream

threshold - the embargo threshold date

type - the type of calculation

Returns:

the access status

Throws:

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