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

Interface ApprovalServiceProvider

All Known Implementing Classes:

ApprovalServiceProviderImplementation

public interface ApprovalServiceProvider

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

Method Summary

Modifier and Type	Method and Description
void	accept(java.lang.String ticket, int reviewerId) Accept a PublicReference and publish to public.
void	acceptTicketByUser(java.lang.String ticket, int reviewerId) Accept an open ticket by the user who requested the data publication to get a final persistent ID
void	approve(PublicReference reference, javax.mail.internet.InternetAddress emailNotificationAddress) Initialize a request to approve a PublicReference.
void	checkOpenReviews(java.util.Map<PublicReference,java.util.List<ReviewStatus>> results) Check all ReviewStatus of the given PublicReference by calling ReviewProcess.review(List).
java.util.Map<PublicReference,java.util.List<ReviewStatus>>	getAllOpenReviews() Load all open PublicReferences that are not yet accepted or rejected.
java.lang.String	getNewURL(PublicReference reference) Create an new URL for a PublicReference for URLReference
PublicReference	getPublicReferenceByInternalId(java.lang.String internalId) Get a PublicReference object by the internal UUID for generating HTML template
void	reject(java.lang.String ticket, int reviewerId) Reject a PublicReference.
void	rejectTicketByUser(java.lang.String ticket, int reviewerId) Reject an open ticket by the user who requested to discard the process and not getting a persistent ID
java.lang.String	storePersistentID(PublicReference reference, java.lang.String id, int year) Store the generated DataCiteReference in to the eDAL system.

Method Detail

accept

void accept(java.lang.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(java.lang.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.

getAllOpenReviews

java.util.Map<PublicReference,java.util.List<ReviewStatus>> getAllOpenReviews()

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.

checkOpenReviews

void checkOpenReviews(java.util.Map<PublicReference,java.util.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

java.lang.String getNewURL(PublicReference reference)
                    throws EdalApprovalException

Create an new URL for a PublicReference for URLReference

Parameters:

reference - the PublicReference to get a URL

Returns:

a new URL as String

Throws:

EdalApprovalException - if unable to get a URL

storePersistentID

java.lang.String storePersistentID(PublicReference reference,
                                   java.lang.String id,
                                   int year)
                            throws EdalApprovalException

Store the generated DataCiteReference in to the eDAL system.

Parameters:

reference - the corresponding PublicReference

id - the ID as String

year - the year of the ID

Returns:

the final ID as String

Throws:

EdalApprovalException - if unable to store the ID

getPublicReferenceByInternalId

PublicReference getPublicReferenceByInternalId(java.lang.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 - if unable get PublicReference

acceptTicketByUser

void acceptTicketByUser(java.lang.String ticket,
                        int reviewerId)
                 throws EdalApprovalException

Accept an open ticket by the user who requested the data publication to get a final persistent ID

Parameters:

ticket - the ticket of the open request

reviewerId - the id of the reviewer

Throws:

EdalApprovalException - if unable to accept the request

rejectTicketByUser

void rejectTicketByUser(java.lang.String ticket,
                        int reviewerId)
                 throws EdalApprovalException

Reject an open ticket by the user who requested to discard the process and not getting a persistent ID

Parameters:

ticket - the ticket of the open request

reviewerId - the id of the reviewer

Throws:

EdalApprovalException - if unable to accept the request