org.kuali.kra.common.specialreview.service.impl

Class SpecialReviewServiceImpl

java.lang.Object

org.kuali.kra.common.specialreview.service.impl.SpecialReviewServiceImpl

All Implemented Interfaces:

SpecialReviewService

public class SpecialReviewServiceImpl
extends Object
implements SpecialReviewService

Implements the SpecialReviewService.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NEW_SPECIAL_REVIEW_COMMENT

Constructor Summary

Constructors

Constructor and Description
SpecialReviewServiceImpl()

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.
AwardService	getAwardService()
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService()
org.kuali.rice.krad.service.DocumentService	getDocumentService()
IacucProtocolFinderDao	getIacucProtocolFinderDao()
InstitutionalProposalService	getInstitutionalProposalService()
ProtocolFinderDao	getProtocolFinderDao()
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.
void	setAwardService(AwardService awardService)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
void	setIacucProtocolFinderDao(IacucProtocolFinderDao iacucProtocolFinderDao)
void	setInstitutionalProposalService(InstitutionalProposalService institutionalProposalService)
void	setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)

Methods inherited from class java.lang.Object

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

Field Detail

NEW_SPECIAL_REVIEW_COMMENT

public static final String NEW_SPECIAL_REVIEW_COMMENT

See Also:

Constant Field Values

Constructor Detail

SpecialReviewServiceImpl

public SpecialReviewServiceImpl()

Method Detail

getProtocolSaveLocationPrefix

public 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.

Specified by:

getProtocolSaveLocationPrefix in interface SpecialReviewService

Parameters:

parameters - The parameters from the request

Returns:

the prefix string

See Also:

SpecialReviewService.getProtocolSaveLocationPrefix(java.util.Map)

getProtocolIndex

public 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.

Specified by:

getProtocolIndex in interface SpecialReviewService

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

See Also:

SpecialReviewService.getProtocolIndex(java.lang.String)

getViewSpecialReviewProtocolRouteHeaderId

public String getViewSpecialReviewProtocolRouteHeaderId(String protocolNumber)
                                                 throws Exception

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

Specified by:

getViewSpecialReviewProtocolRouteHeaderId in interface SpecialReviewService

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

See Also:

SpecialReviewService.getViewSpecialReviewProtocolRouteHeaderId(java.lang.String)

getViewSpecialReviewProtocolRouteHeaderId

public String getViewSpecialReviewProtocolRouteHeaderId(String protocolNumber,
                                               String specialReviewTypeCode)
                                                 throws Exception

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

Specified by:

getViewSpecialReviewProtocolRouteHeaderId in interface SpecialReviewService

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

See Also:

SpecialReviewService.getViewSpecialReviewProtocolRouteHeaderId(java.lang.String, java.lang.String)

isLinkedToProtocolFundingSource

public 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.

Specified by:

isLinkedToProtocolFundingSource in interface SpecialReviewService

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:

See Also:

SpecialReviewService.isLinkedToProtocolFundingSource(java.lang.String, java.lang.String, java.lang.String)

isLinkedToSpecialReview

public 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.

Specified by:

isLinkedToSpecialReview in interface SpecialReviewService

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:

See Also:

SpecialReviewService.isLinkedToSpecialReview(java.lang.String, java.lang.String, java.lang.String)

addProtocolFundingSourceForSpecialReview

public 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.

Specified by:

addProtocolFundingSourceForSpecialReview in interface SpecialReviewService

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

See Also:

SpecialReviewService.addProtocolFundingSourceForSpecialReview(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

deleteProtocolFundingSourceForSpecialReview

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

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

Specified by:

deleteProtocolFundingSourceForSpecialReview in interface SpecialReviewService

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

See Also:

SpecialReviewService.deleteProtocolFundingSourceForSpecialReview(java.lang.String, java.lang.String, java.lang.String)

addSpecialReviewForProtocolFundingSource

public 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.

Specified by:

addSpecialReviewForProtocolFundingSource in interface SpecialReviewService

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

See Also:

SpecialReviewService.addSpecialReviewForProtocolFundingSource(java.lang.String, java.lang.String, java.lang.String, java.sql.Date, java.sql.Date, java.sql.Date, java.util.List)

deleteSpecialReviewForProtocolFundingSource

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

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

Specified by:

deleteSpecialReviewForProtocolFundingSource in interface SpecialReviewService

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

See Also:

SpecialReviewService.deleteSpecialReviewForProtocolFundingSource(java.lang.String, java.lang.String, java.lang.String)

getAwardService

public AwardService getAwardService()

setAwardService

public void setAwardService(AwardService awardService)

getInstitutionalProposalService

public InstitutionalProposalService getInstitutionalProposalService()

setInstitutionalProposalService

public void setInstitutionalProposalService(InstitutionalProposalService institutionalProposalService)

getIacucProtocolFinderDao

public IacucProtocolFinderDao getIacucProtocolFinderDao()

setIacucProtocolFinderDao

public void setIacucProtocolFinderDao(IacucProtocolFinderDao iacucProtocolFinderDao)

getProtocolFinderDao

public ProtocolFinderDao getProtocolFinderDao()

setProtocolFinderDao

public void setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)

getDocumentService

public org.kuali.rice.krad.service.DocumentService getDocumentService()

setDocumentService

public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)