de.ipk_gatersleben.bit.bi.edal.primary_data.reference

Interface ApprovalServiceProvider

public interface ApprovalServiceProvider

Provide the implementation for the ApprovalService to get a persistent identifier.

Author:

arendd

Method Summary

Methods

Modifier and Type	Method and Description
void	accept(String ticket, int reviewerID) Accept a PublicReference and publish to public.
void	acceptTicketByUser(String ticket, int reviewerHashCode)
void	approve(PublicReference reference, javax.mail.internet.InternetAddress emailNotificationAddress) Initialize a request to approve a PublicReference.
void	checkOpenReviewProcesses(Map<PublicReference,List<ReviewStatus>> results) Check all ReviewStatus of the given PublicReference by calling ReviewProcess.review(List).
Map<PublicReference,List<ReviewStatus>>	getAllOpenReviewProcesses() Load all open PublicReferences that are not yet accepted or rejected.
String	getNewURL(PublicReference reference) Create an new URL for a PublicReference for URLReference
PublicReference	getPublicReferenceByInternalId(String internalId) Get a PublicReference object by the internal UUID for generating HTML template
void	reject(String ticket, int reviewerID) Reject a PublicReference.
void	rejectTicketByUser(String ticket, int reviewerHashCode)
String	storeNewDOI(PublicReference reference, String doi, int year) Store the generated DataCiteReference in to the eDAL system.

Method Detail

accept

void accept(String ticket,
          int reviewerID)
            throws EdalApprovalException

Accept a PublicReference and publish to public.

Parameters:

ticket - the ticket number to identify the approved PublicReference.

reviewerID - the ID to identify the reviewer.

Throws:

EdalApprovalException - if unable to accept the ticket.

approve

void approve(PublicReference reference,
           javax.mail.internet.InternetAddress emailNotificationAddress)
             throws EdalApprovalException

Initialize a request to approve a PublicReference.

Parameters:

reference - the PublicReference to approve.

emailNotificationAddress - the eMail address of the requesting user

Throws:

EdalApprovalException - if unable to initialize the approval request.

reject

void reject(String ticket,
          int reviewerID)
            throws EdalApprovalException

Reject a PublicReference.

Parameters:

ticket - the ticket number to identify the rejected PublicReference.

reviewerID - the ID to identify the reviewer.

Throws:

EdalApprovalException - if unable to reject the ticket.

getAllOpenReviewProcesses

Map<PublicReference,List<ReviewStatus>> getAllOpenReviewProcesses()

Load all open PublicReferences that are not yet accepted or rejected.

Returns:

a Map with all open PublicReferences and the corresponding List with the ReviewStatus.

checkOpenReviewProcesses

void checkOpenReviewProcesses(Map<PublicReference,List<ReviewStatus>> results)
                              throws EdalApprovalException

Check all ReviewStatus of the given PublicReference by calling ReviewProcess.review(List).

Parameters:

results - a Map with all open PublicReferences and their ReviewStatus.

Throws:

EdalApprovalException - if unable to check open review processes.

getNewURL

String getNewURL(PublicReference reference)
                 throws EdalApprovalException

Create an new URL for a PublicReference for URLReference

Parameters:

reference -

Returns:

an new URL as String

Throws:

EdalApprovalException

storeNewDOI

String storeNewDOI(PublicReference reference,
                 String doi,
                 int year)
                   throws EdalApprovalException

Store the generated DataCiteReference in to the eDAL system.

Parameters:

reference - the corresponding PublicReference

doi - the DOI as String

year - the year of the DOI

Returns:

the final DOI as String

Throws:

EdalApprovalException - if unable to store DOI

getPublicReferenceByInternalId

PublicReference getPublicReferenceByInternalId(String internalId)
                                               throws EdalException

Get a PublicReference object by the internal UUID for generating HTML template

Parameters:

internalId - as String

Returns:

the corresponding PublicReference

Throws:

EdalException

acceptTicketByUser

void acceptTicketByUser(String ticket,
                      int reviewerHashCode)
                        throws EdalApprovalException

Throws:

EdalApprovalException

rejectTicketByUser

void rejectTicketByUser(String ticket,
                      int reviewerHashCode)
                        throws EdalApprovalException

Throws:

EdalApprovalException