org.kuali.kra.protocol.actions.copy

Interface ProtocolCopyService<GenericProtocolDocument extends ProtocolDocumentBase>

All Known Subinterfaces:

IacucProtocolCopyService, ProtocolCopyService

All Known Implementing Classes:

IacucProtocolCopyServiceImpl, ProtocolCopyServiceImpl, ProtocolCopyServiceImplBase

public interface ProtocolCopyService<GenericProtocolDocument extends ProtocolDocumentBase>

The ProtocolBase Copy Service is responsible for copying protocols.

Author:

Kuali Research Administration Team (kualidev@oncourse.iu.edu)

Method Summary

Methods

Modifier and Type	Method and Description
GenericProtocolDocument	copyProtocol(GenericProtocolDocument doc) Copy a protocol document.
ProtocolDocumentBase	copyProtocol(GenericProtocolDocument doc, String protocolNumber, boolean isAmendmentRenewal) Copy a protocol document with a given protocol number.

Method Detail

copyProtocol

GenericProtocolDocument copyProtocol(GenericProtocolDocument doc)
                                                                  throws Exception

Copy a protocol document.

Parameters:

doc - the protocol document to copy.

Returns:

the new document that is saved in the database; otherwise null if an error occurred, e.g. the user didn't have permission to copy the document

Throws:

Exception - if anything really bad happens

copyProtocol

ProtocolDocumentBase copyProtocol(GenericProtocolDocument doc,
                                String protocolNumber,
                                boolean isAmendmentRenewal)
                                  throws Exception

Copy a protocol document with a given protocol number. This is used when protocols are copied for amendments and renewals. Instead of creating a new protocol number, the original one is appended to.

Parameters:

doc - the protocol document to copy.

protocolNumber - the protocol number to assign to the protocol

Returns:

the new document that is saved in the database; otherwise null if an error occurred, e.g. the user didn't have permission to copy the document

Throws:

Exception - if anything really bad happens