org.kuali.kra.protocol.actions.amendrenew

Class ProtocolAmendRenewServiceImplBase

java.lang.Object

org.kuali.kra.protocol.actions.amendrenew.ProtocolAmendRenewServiceImplBase

All Implemented Interfaces:

ProtocolAmendRenewService

Direct Known Subclasses:

IacucProtocolAmendRenewServiceImpl, ProtocolAmendRenewServiceImpl

public abstract class ProtocolAmendRenewServiceImplBase
extends Object
implements ProtocolAmendRenewService

This class...

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AMEND_ID
protected static String	AMEND_NEXT_VALUE
protected static String	AMENDMENT
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected static String	CREATED
protected static int	DIGIT_COUNT
protected org.kuali.rice.krad.service.DocumentService	documentService
protected KraLookupDao	kraLookupDao
protected static String	PROTOCOL_NUMBER
protected static String	PROTOCOL_STATUS
protected ProtocolCopyService	protocolCopyService
protected ProtocolFinderDao	protocolFinderDao
protected QuestionnaireAnswerService	questionnaireAnswerService
protected static String	RENEW_ID
protected static String	RENEW_NEXT_VALUE
protected static String	RENEWAL
protected org.kuali.rice.krad.service.SequenceAccessorService	sequenceAccessorService

Fields inherited from interface org.kuali.kra.protocol.actions.amendrenew.ProtocolAmendRenewService

AMEND_RENEW_ALLOW_NEW_PROTOCOL_DOCUMENT

Constructor Summary

Constructors

Constructor and Description
ProtocolAmendRenewServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract void	addModules(ProtocolBase protocol, ProtocolAmendmentBean amendmentBean)
String	createAmendment(ProtocolDocumentBase protocolDocument, ProtocolAmendmentBean amendmentBean) Create an amendment.
protected String	createAmendment(ProtocolDocumentBase protocolDocument, ProtocolDocumentBase amendProtocolDocument, ProtocolAmendmentBean amendmentBean) Create an Amendment.
protected ProtocolAmendRenewalBase	createAmendmentRenewal(ProtocolDocumentBase protocolDocument, ProtocolDocumentBase amendProtocolDocument, String summary) Create an Amendment Entry.
protected ProtocolActionBase	createCreateAmendmentProtocolAction(ProtocolBase protocol, String protocolNumber) Create a ProtocolBase Action indicating that an amendment has been created.
protected ProtocolActionBase	createCreateRenewalProtocolAction(ProtocolBase protocol, String protocolNumber) Create a ProtocolBase Action indicating that a renewal has been created.
protected ProtocolAmendRenewModuleBase	createModule(ProtocolAmendRenewalBase amendmentEntry, String moduleTypeCode) Create a module entry.
String	createRenewal(ProtocolDocumentBase protocolDocument, String renewalSummary) Create a Renewal without an Amendment.
String	createRenewalWithAmendment(ProtocolDocumentBase protocolDocument, ProtocolAmendmentBean amendmentBean) Create a Renewal with an Amendment.
protected String	generateProtocolAmendmentNumber(ProtocolDocumentBase protocolDocument) Generate the protocol number for an amendment.
protected String	generateProtocolNumber(ProtocolDocumentBase protocolDocument, String letter, String nextValueKey) Generate the protocol number for an amendment or renewal.
protected String	generateProtocolRenewalNumber(ProtocolDocumentBase protocolDocument) Generate the protocol number for an renewal.
protected abstract List<String>	getAllModuleTypeCodes()
List<ProtocolBase>	getAmendmentAndRenewals(String protocolNumber) Get all of the Amendments and Renewals for a given protocol.
protected abstract String	getAmendmentInProgressStatusHook()
Collection<ProtocolBase>	getAmendments(String protocolNumber) This method returns all of the amendments associated with a protocol.
List<String>	getAvailableModules(String protocolNumber) Get the list of protocol modules that can be amended.
protected abstract ProtocolActionBase	getNewAmendmentProtocolActionInstanceHook(ProtocolBase protocol)
protected abstract ProtocolAmendRenewalBase	getNewProtocolAmendRenewalInstanceHook()
protected abstract ProtocolAmendRenewModuleBase	getNewProtocolAmendRenewModuleInstanceHook()
protected abstract ModuleQuestionnaireBean	getNewProtocolModuleQuestionnaireBeanInstanceHook(ProtocolBase protocol)
protected abstract ProtocolActionBase	getNewRenewalProtocolActionInstanceHook(ProtocolBase protocol)
protected abstract Class<? extends ProtocolBase>	getProtocolBOClassHook()
ProtocolCopyService<ProtocolDocumentBase>	getProtocolCopyService()
protected abstract String	getRenewalInProgressStatusHook()
Collection<ProtocolBase>	getRenewals(String protocolNumber) This method returns all of the renewals associated with a protocol.
protected org.kuali.rice.kew.api.WorkflowDocument	getWorkflowDocument(org.kuali.rice.krad.document.Document doc) Get the corresponding workflow document.
protected boolean	isAmendmentCompleted(ProtocolBase protocol) Has the amendment completed, e.g.
protected void	markProtocolAttachmentsAsFinalized(List<ProtocolAttachmentProtocolBase> attachmentProtocols) This method marks all protocol attachment as finalized.
protected void	removeEditedQuestionaire(ProtocolBase protocol)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Set the Document Service.
void	setKraLookupDao(KraLookupDao kraLookupDao) Set the KRA Lookup DAO.
void	setProtocolCopyService(ProtocolCopyService protocolCopyService) Set the ProtocolBase Copy Service.
void	setProtocolFinderDao(ProtocolFinderDao protocolFinderDao) Set the KRA Lookup DAO.
void	setQuestionnaireAnswerService(QuestionnaireAnswerService questionnaireAnswerService)
void	setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService) Set the Sequence Accessor Service.
void	updateAmendmentRenewal(ProtocolDocumentBase protocolDocument, ProtocolAmendmentBean amendmentBean) Update the summary and amendment sections.

Methods inherited from class java.lang.Object

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

Field Detail

AMEND_ID

protected static final String AMEND_ID

See Also:

Constant Field Values

RENEW_ID

protected static final String RENEW_ID

See Also:

Constant Field Values

DIGIT_COUNT

protected static final int DIGIT_COUNT

See Also:

Constant Field Values

AMEND_NEXT_VALUE

protected static final String AMEND_NEXT_VALUE

See Also:

Constant Field Values

RENEW_NEXT_VALUE

protected static final String RENEW_NEXT_VALUE

See Also:

Constant Field Values

AMENDMENT

protected static final String AMENDMENT

See Also:

Constant Field Values

RENEWAL

protected static final String RENEWAL

See Also:

Constant Field Values

CREATED

protected static final String CREATED

See Also:

Constant Field Values

PROTOCOL_NUMBER

protected static final String PROTOCOL_NUMBER

See Also:

Constant Field Values

PROTOCOL_STATUS

protected static final String PROTOCOL_STATUS

See Also:

Constant Field Values

documentService

protected org.kuali.rice.krad.service.DocumentService documentService

protocolCopyService

protected ProtocolCopyService protocolCopyService

kraLookupDao

protected KraLookupDao kraLookupDao

protocolFinderDao

protected ProtocolFinderDao protocolFinderDao

sequenceAccessorService

protected org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService

questionnaireAnswerService

protected QuestionnaireAnswerService questionnaireAnswerService

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

Constructor Detail

ProtocolAmendRenewServiceImplBase

public ProtocolAmendRenewServiceImplBase()

Method Detail

setDocumentService

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

Set the Document Service.

Parameters:

documentService -

setProtocolCopyService

public void setProtocolCopyService(ProtocolCopyService protocolCopyService)

Set the ProtocolBase Copy Service.

Parameters:

protocolCopyService -

setSequenceAccessorService

public void setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService)

Set the Sequence Accessor Service.

Parameters:

sequenceAccessorService -

setKraLookupDao

public void setKraLookupDao(KraLookupDao kraLookupDao)

Set the KRA Lookup DAO.

Parameters:

kraLookupDao -

setProtocolFinderDao

public void setProtocolFinderDao(ProtocolFinderDao protocolFinderDao)

Set the KRA Lookup DAO.

Parameters:

kraLookupDao -

createAmendment

public String createAmendment(ProtocolDocumentBase protocolDocument,
                     ProtocolAmendmentBean amendmentBean)
                       throws Exception

Description copied from interface: ProtocolAmendRenewService

Create an amendment. An amendment is simply a copy of a protocol with specific sections (modules) designated for modification.

Specified by:

createAmendment in interface ProtocolAmendRenewService

Parameters:

protocolDocument - the protocol document to create an amendment from

amendmentBean - the amendment info (which modules to be amended)

Returns:

the amendment's document number

Throws:

Exception

See Also:

ProtocolAmendRenewService.createAmendment(org.kuali.kra.protocol.ProtocolDocumentBase, org.kuali.kra.protocol.actions.amendrenew.ProtocolAmendmentBean)

markProtocolAttachmentsAsFinalized

protected void markProtocolAttachmentsAsFinalized(List<ProtocolAttachmentProtocolBase> attachmentProtocols)

This method marks all protocol attachment as finalized.

Parameters:

attachmentProtocols -

createRenewal

public String createRenewal(ProtocolDocumentBase protocolDocument,
                   String renewalSummary)
                     throws Exception

Description copied from interface: ProtocolAmendRenewService

Create a Renewal without an Amendment.

Specified by:

createRenewal in interface ProtocolAmendRenewService

Parameters:

protocolDocument - the protocol document to renew

renewalSummary - renewal summary

Returns:

the renewal's document number

Throws:

Exception

See Also:

ProtocolAmendRenewService.createRenewal(org.kuali.kra.protocol.ProtocolDocumentBase, java.lang.String)

createRenewalWithAmendment

public String createRenewalWithAmendment(ProtocolDocumentBase protocolDocument,
                                ProtocolAmendmentBean amendmentBean)
                                  throws Exception

Description copied from interface: ProtocolAmendRenewService

Create a Renewal with an Amendment.

Specified by:

createRenewalWithAmendment in interface ProtocolAmendRenewService

Parameters:

protocolDocument - the protocol document to renew/amend

amendmentBean - the amendment info (which modules to be amended)

Returns:

the renewal's document number

Throws:

Exception

See Also:

org.kuali.kra.irb.actions.amendrenew.ProtocolAmendRenewService#createRenewalWithAmendment(org.kuali.kra.irb.ProtocolDocumentBase, org.kuali.kra.irb.actions.amendrenew.ProtocolAmendmentBean)

updateAmendmentRenewal

public void updateAmendmentRenewal(ProtocolDocumentBase protocolDocument,
                          ProtocolAmendmentBean amendmentBean)
                            throws org.kuali.rice.kew.api.exception.WorkflowException

Description copied from interface: ProtocolAmendRenewService

Update the summary and amendment sections.

Specified by:

updateAmendmentRenewal in interface ProtocolAmendRenewService

Parameters:

protocolDocument - the protocol document of the amendment/renewal to be updated

amendmentBean - the amendment info (summary and which modules to be amended)

Throws:

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

See Also:

org.kuali.kra.irb.actions.amendrenew.ProtocolAmendRenewService#updateAmendmentRenewal(org.kuali.kra.irb.ProtocolDocumentBase, org.kuali.kra.irb.actions.amendrenew.ProtocolAmendmentBean)

createAmendment

protected String createAmendment(ProtocolDocumentBase protocolDocument,
                     ProtocolDocumentBase amendProtocolDocument,
                     ProtocolAmendmentBean amendmentBean)
                          throws org.kuali.rice.kew.api.exception.WorkflowException

Create an Amendment. Adds an amendment entry into the database as well as the modules that can be modified with this amendment.

Parameters:

protocolDocument - the original protocol document to be amended

amendProtocolDocument - the amended protocol document

amendmentBean - the amendment bean info

Returns:

Throws:

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

generateProtocolAmendmentNumber

protected String generateProtocolAmendmentNumber(ProtocolDocumentBase protocolDocument)

Generate the protocol number for an amendment. The protocol number for an amendment is the original protocol's number appended with "Axxx" where "xxx" is the next sequence number. A protocol can have more than one amendment.

Parameters:

protocolDocument -

Returns:

generateProtocolRenewalNumber

protected String generateProtocolRenewalNumber(ProtocolDocumentBase protocolDocument)

Generate the protocol number for an renewal. The protocol number for an renewal is the original protocol's number appended with "Rxxx" where "xxx" is the next sequence number.

Parameters:

protocolDocument -

Returns:

generateProtocolNumber

protected String generateProtocolNumber(ProtocolDocumentBase protocolDocument,
                            String letter,
                            String nextValueKey)

Generate the protocol number for an amendment or renewal.

Parameters:

protocolDocument -

Returns:

createAmendmentRenewal

protected ProtocolAmendRenewalBase createAmendmentRenewal(ProtocolDocumentBase protocolDocument,
                                              ProtocolDocumentBase amendProtocolDocument,
                                              String summary)

Create an Amendment Entry.

Parameters:

protocolDocument - the original protocol document

amendProtocolDocument - the amended protocol document

amendmentBean - the user form containing the summary and modules to be amended

Returns:

removeEditedQuestionaire

protected void removeEditedQuestionaire(ProtocolBase protocol)

createModule

protected ProtocolAmendRenewModuleBase createModule(ProtocolAmendRenewalBase amendmentEntry,
                                        String moduleTypeCode)

Create a module entry.

Parameters:

amendmentEntry -

moduleTypeCode -

Returns:

createCreateAmendmentProtocolAction

protected ProtocolActionBase createCreateAmendmentProtocolAction(ProtocolBase protocol,
                                                     String protocolNumber)

Create a ProtocolBase Action indicating that an amendment has been created.

Parameters:

protocol -

protocolNumber - protocol number of the amendment

Returns:

a protocol action

createCreateRenewalProtocolAction

protected ProtocolActionBase createCreateRenewalProtocolAction(ProtocolBase protocol,
                                                   String protocolNumber)

Create a ProtocolBase Action indicating that a renewal has been created.

Parameters:

protocol -

protocolNumber - protocol number of the renewal

Returns:

a protocol action

getAmendmentAndRenewals

public List<ProtocolBase> getAmendmentAndRenewals(String protocolNumber)
                                           throws Exception

Description copied from interface: ProtocolAmendRenewService

Get all of the Amendments and Renewals for a given protocol.

Specified by:

getAmendmentAndRenewals in interface ProtocolAmendRenewService

Parameters:

protocolNumber - the protocol number

Returns:

the list of amendments and renewals

Throws:

Exception

See Also:

ProtocolAmendRenewService.getAmendmentAndRenewals(java.lang.String)

getAmendments

public Collection<ProtocolBase> getAmendments(String protocolNumber)
                                       throws Exception

Description copied from interface: ProtocolAmendRenewService

This method returns all of the amendments associated with a protocol.

Specified by:

getAmendments in interface ProtocolAmendRenewService

Returns:

the list of amendments

Throws:

Exception

getRenewals

public Collection<ProtocolBase> getRenewals(String protocolNumber)
                                     throws Exception

Description copied from interface: ProtocolAmendRenewService

This method returns all of the renewals associated with a protocol.

Specified by:

getRenewals in interface ProtocolAmendRenewService

Returns:

the list of renewals

Throws:

Exception

getAvailableModules

public List<String> getAvailableModules(String protocolNumber)
                                 throws Exception

Description copied from interface: ProtocolAmendRenewService

Get the list of protocol modules that can be amended. Modules that are currently being modified by outstanding amendments are not returned in this list.

Specified by:

getAvailableModules in interface ProtocolAmendRenewService

Parameters:

protocolNumber - the protocol number

Returns:

the list of protocol module type codes the user can amend

Throws:

Exception

See Also:

ProtocolAmendRenewService.getAvailableModules(java.lang.String)

isAmendmentCompleted

protected boolean isAmendmentCompleted(ProtocolBase protocol)

Has the amendment completed, e.g. been approved, disapproved, etc?

Parameters:

protocol -

Returns:

getWorkflowDocument

protected org.kuali.rice.kew.api.WorkflowDocument getWorkflowDocument(org.kuali.rice.krad.document.Document doc)

Get the corresponding workflow document.

Parameters:

doc - the document

Returns:

the workflow document or null if there is none

setQuestionnaireAnswerService

public void setQuestionnaireAnswerService(QuestionnaireAnswerService questionnaireAnswerService)

setBusinessObjectService

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

getNewAmendmentProtocolActionInstanceHook

protected abstract ProtocolActionBase getNewAmendmentProtocolActionInstanceHook(ProtocolBase protocol)

getNewRenewalProtocolActionInstanceHook

protected abstract ProtocolActionBase getNewRenewalProtocolActionInstanceHook(ProtocolBase protocol)

getNewProtocolModuleQuestionnaireBeanInstanceHook

protected abstract ModuleQuestionnaireBean getNewProtocolModuleQuestionnaireBeanInstanceHook(ProtocolBase protocol)

getAmendmentInProgressStatusHook

protected abstract String getAmendmentInProgressStatusHook()

getRenewalInProgressStatusHook

protected abstract String getRenewalInProgressStatusHook()

getAllModuleTypeCodes

protected abstract List<String> getAllModuleTypeCodes()

addModules

protected abstract void addModules(ProtocolBase protocol,
              ProtocolAmendmentBean amendmentBean)

getProtocolBOClassHook

protected abstract Class<? extends ProtocolBase> getProtocolBOClassHook()

getNewProtocolAmendRenewalInstanceHook

protected abstract ProtocolAmendRenewalBase getNewProtocolAmendRenewalInstanceHook()

getNewProtocolAmendRenewModuleInstanceHook

protected abstract ProtocolAmendRenewModuleBase getNewProtocolAmendRenewModuleInstanceHook()

getProtocolCopyService

public ProtocolCopyService<ProtocolDocumentBase> getProtocolCopyService()