org.kuali.kra.common.specialreview.service

Interface SpecialReviewService

All Known Implementing Classes:

SpecialReviewServiceImpl

public interface SpecialReviewService

Provides services for linking an IRB Protocol with other modules.

Method Summary

Methods

Modifier and Type	Method and Description
void	addProtocolFundingSourceForSpecialReview(String protocolNumber, String fundingSourceNumber, String fundingSourceTypeCode, String fundingSourceName, String fundingSourceTitle) Creates a Protocol Funding Source from a Special Review contained in either an Institutional Proposal or Award and adds it to the Protocol.
void	addSpecialReviewForProtocolFundingSource(String fundingSourceNumber, String fundingSourceTypeCode, String protocolNumber, Date applicationDate, Date approvalDate, Date expirationDate, List<String> exemptionTypeCodes) Creates an Institutional Proposal or Award Special Review based on the given Protocol and adds it to the specified Institutional Proposal or Award.
void	deleteProtocolFundingSourceForSpecialReview(String protocolNumber, String fundingSourceNumber, String fundingSourceTypeCode) Deletes the Protocol Funding Sources associated with the Special Review being deleted.
void	deleteSpecialReviewForProtocolFundingSource(String fundingSourceNumber, String fundingSourceTypeCode, String protocolNumber) Deletes the Institutional Proposal Special Review associated with the Protocol Funding Source being deleted.
int	getProtocolIndex(String prefix) Gets the index of the protocol included in the prefix string.
String	getProtocolSaveLocationPrefix(Map<String,String[]> parameters) Gets the save location prefix string before the protocol number included in the parameter map.
String	getViewSpecialReviewProtocolRouteHeaderId(String protocolNumber) Gets the route header id of the document represented by the given protocolNumber.
String	getViewSpecialReviewProtocolRouteHeaderId(String protocolNumber, String specialReviewTypeCode) Gets the route header id of the document represented by the given protocolNumber.
boolean	isLinkedToProtocolFundingSource(String protocolNumber, String fundingSourceNumber, String fundingSourceTypeCode) Determines whether the given Protocol contains a Funding Source linking to the Institutional Proposal or Award corresponding to the given number.
boolean	isLinkedToSpecialReview(String fundingSourceNumber, String fundingSourceTypeCode, String protocolNumber) Determines whether the given Institutional Proposal or Award Protocol contains a Special Review linking to the given protocol number.

Method Detail

getProtocolSaveLocationPrefix

String getProtocolSaveLocationPrefix(Map<String,String[]> parameters)

Gets the save location prefix string before the protocol number included in the parameter map.

This prefix can either be specialReviewHelper.newSpecialReview for a new Special Review or a string similar to document.protocolList[0].specialReviews[0] for an existing Special Review.

Parameters:

parameters - The parameters from the request

Returns:

the prefix string

getProtocolIndex

int getProtocolIndex(String prefix)

Gets the index of the protocol included in the prefix string. This string must be in a form similar to document.protocolList[0].specialReviews[0], or else the method will return -1.

Parameters:

prefix - The prefix string in the form document.protocolList[0].specialReviews[0]

Returns:

the index of the protocol, or -1 if it does not exist

getViewSpecialReviewProtocolRouteHeaderId

String getViewSpecialReviewProtocolRouteHeaderId(String protocolNumber)
                                                 throws Exception

Gets the route header id of the document represented by the given protocolNumber.

Parameters:

protocolNumber - The number of the protocol

Returns:

the route header id of the protocol document, or 0L if the protocolNumber is invalid

Throws:

Exception

getViewSpecialReviewProtocolRouteHeaderId

String getViewSpecialReviewProtocolRouteHeaderId(String protocolNumber,
                                               String specialReviewTypeCode)
                                                 throws Exception

Gets the route header id of the document represented by the given protocolNumber.

Parameters:

protocolNumber - The number of the protocol

specialReviewTypeCode - for the protocol

Returns:

the route header id of the protocol document, or 0L if the protocolNumber is invalid

Throws:

Exception

isLinkedToProtocolFundingSource

boolean isLinkedToProtocolFundingSource(String protocolNumber,
                                      String fundingSourceNumber,
                                      String fundingSourceTypeCode)

Determines whether the given Protocol contains a Funding Source linking to the Institutional Proposal or Award corresponding to the given number.

Parameters:

protocolNumber - The number of the Protocol in which to check for the Funding Source

fundingSourceNumber - The number of the Institutional Proposal or Award to check for

fundingSourceTypeCode - The type code (for either Institutional Proposal or Award) to check for

Returns:

isLinkedToSpecialReview

boolean isLinkedToSpecialReview(String fundingSourceNumber,
                              String fundingSourceTypeCode,
                              String protocolNumber)

Determines whether the given Institutional Proposal or Award Protocol contains a Special Review linking to the given protocol number.

Parameters:

fundingSourceNumber - The number of the Institutional Proposal or Award in which to check for the Special Review

fundingSourceTypeCode - The type code (for either Institutional Proposal or Award) in which to check for the Special Review

protocolNumber - The number of the Protocol to check for

Returns:

addProtocolFundingSourceForSpecialReview

void addProtocolFundingSourceForSpecialReview(String protocolNumber,
                                            String fundingSourceNumber,
                                            String fundingSourceTypeCode,
                                            String fundingSourceName,
                                            String fundingSourceTitle)

Creates a Protocol Funding Source from a Special Review contained in either an Institutional Proposal or Award and adds it to the Protocol.

Parameters:

protocolNumber - The number of the Protocol to which to add the new Funding Source

fundingSourceNumber - The human-readable number of the Institutional Proposal or Award in which the Special Review is added/saved

fundingSourceTypeCode - The type code (for either Institutional Proposal or Award) of the entity in which the Special Review is added/saved

fundingSourceName - The name of the Institutional Proposal or Award in which the Special Review is added/saved

fundingSourceTitle - The title of the Institutional Proposal or Award in which the Special Review is added/saved

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

deleteProtocolFundingSourceForSpecialReview

void deleteProtocolFundingSourceForSpecialReview(String protocolNumber,
                                               String fundingSourceNumber,
                                               String fundingSourceTypeCode)

Deletes the Protocol Funding Sources associated with the Special Review being deleted.

Parameters:

protocolNumber - The number of the Protocol to which to delete the Funding Sources

fundingSourceNumber - The number of the Institutional Proposal or Award in which the Special Review is deleted

fundingSourceTypeCode - The type code (for either Institutional Proposal or Award) of the entity in which the Special Review is deleted

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

addSpecialReviewForProtocolFundingSource

void addSpecialReviewForProtocolFundingSource(String fundingSourceNumber,
                                            String fundingSourceTypeCode,
                                            String protocolNumber,
                                            Date applicationDate,
                                            Date approvalDate,
                                            Date expirationDate,
                                            List<String> exemptionTypeCodes)

Creates an Institutional Proposal or Award Special Review based on the given Protocol and adds it to the specified Institutional Proposal or Award.

Parameters:

fundingSourceNumber - The number of the Institutional Proposal or Award

fundingSourceTypeCode - The type code (for either Institutional Proposal or Award)

protocolNumber - The number of the given Protocol

applicationDate - The application date (submission date) of the given Protocol

approvalDate - The approval date of the given Protocol

expirationDate - The expiration date of the given Protocol

exemptionTypeCodes - The exemption type codes of the given Protocol

Throws:

org.kuali.rice.kew.api.exception.WorkflowException

deleteSpecialReviewForProtocolFundingSource

void deleteSpecialReviewForProtocolFundingSource(String fundingSourceNumber,
                                               String fundingSourceTypeCode,
                                               String protocolNumber)

Deletes the Institutional Proposal Special Review associated with the Protocol Funding Source being deleted.

Parameters:

fundingSourceNumber - The number of the Institutional Proposal or Award to which to delete the Special Review

fundingSourceTypeCode - The type code (for either Institutional Proposal or Award) to which to delete the Special Review

protocolNumber - The number of the Protocol in which the Funding Source is deleted

Throws:

org.kuali.rice.kew.api.exception.WorkflowException