org.kuali.kra.protocol.actions.amendrenew

Interface ProtocolAmendRenewService

All Known Subinterfaces:

IacucProtocolAmendRenewService, ProtocolAmendRenewService

All Known Implementing Classes:

IacucProtocolAmendRenewServiceImpl, ProtocolAmendRenewServiceImpl, ProtocolAmendRenewServiceImplBase

public interface ProtocolAmendRenewService

ProtocolBase Amendment/Renewal Service.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AMEND_RENEW_ALLOW_NEW_PROTOCOL_DOCUMENT

Method Summary

Methods

Modifier and Type	Method and Description
String	createAmendment(ProtocolDocumentBase protocolDocument, ProtocolAmendmentBean amendmentBean) Create an amendment.
String	createRenewal(ProtocolDocumentBase protocolDocument, String renewalSummary) Create a Renewal without an Amendment.
String	createRenewalWithAmendment(ProtocolDocumentBase protocolDocument, ProtocolAmendmentBean amendmentBean) Create a Renewal with an Amendment.
List<ProtocolBase>	getAmendmentAndRenewals(String protocolNumber) Get all of the Amendments and Renewals for a given protocol.
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.
Collection<ProtocolBase>	getRenewals(String protocolNumber) This method returns all of the renewals associated with a protocol.
void	updateAmendmentRenewal(ProtocolDocumentBase protocolDocument, ProtocolAmendmentBean amendmentBean) Update the summary and amendment sections.

Field Detail

AMEND_RENEW_ALLOW_NEW_PROTOCOL_DOCUMENT

static final String AMEND_RENEW_ALLOW_NEW_PROTOCOL_DOCUMENT

See Also:

Constant Field Values

Method Detail

createAmendment

String createAmendment(ProtocolDocumentBase protocolDocument,
                     ProtocolAmendmentBean amendmentBean)
                       throws Exception

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

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

createRenewal

String createRenewal(ProtocolDocumentBase protocolDocument,
                   String renewalSummary)
                     throws Exception

Create a Renewal without an Amendment.

Parameters:

protocolDocument - the protocol document to renew

renewalSummary - renewal summary

Returns:

the renewal's document number

Throws:

Exception

createRenewalWithAmendment

String createRenewalWithAmendment(ProtocolDocumentBase protocolDocument,
                                ProtocolAmendmentBean amendmentBean)
                                  throws Exception

Create a Renewal with an Amendment.

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

updateAmendmentRenewal

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

Update the summary and amendment sections.

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

getAmendmentAndRenewals

List<ProtocolBase> getAmendmentAndRenewals(String protocolNumber)
                                           throws Exception

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

Parameters:

protocolNumber - the protocol number

Returns:

the list of amendments and renewals

Throws:

Exception

Exception

getAmendments

Collection<ProtocolBase> getAmendments(String protocolNumber)
                                       throws Exception

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

Parameters:

protocolNumber -

Returns:

the list of amendments

Throws:

Exception

getRenewals

Collection<ProtocolBase> getRenewals(String protocolNumber)
                                     throws Exception

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

Parameters:

protocolNumber -

Returns:

the list of renewals

Throws:

Exception

getAvailableModules

List<String> getAvailableModules(String protocolNumber)
                                 throws Exception

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.

Parameters:

protocolNumber - the protocol number

Returns:

the list of protocol module type codes the user can amend

Throws:

Exception

Exception