org.kuali.kra.protocol.actions.withdraw

Class ProtocolWithdrawServiceImplBase

java.lang.Object

org.kuali.kra.protocol.actions.withdraw.ProtocolWithdrawServiceImplBase

All Implemented Interfaces:

ProtocolWithdrawService

Direct Known Subclasses:

IacucProtocolWithdrawServiceImpl, ProtocolWithdrawServiceImpl

public abstract class ProtocolWithdrawServiceImplBase
extends Object
implements ProtocolWithdrawService

The ProtocolWithdrawService implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected org.kuali.rice.krad.service.DocumentService	documentService
protected ProtocolActionCorrespondenceGenerationService	protocolActionCorrespondenceGenerationService
protected ProtocolActionService	protocolActionService
protected ProtocolOnlineReviewService	protocolOnlineReviewService
protected ProtocolVersionService	protocolVersionService
protected static String	WITHDRAW_FINALIZE_OLR_ANNOTATION

Constructor Summary

Constructors

Constructor and Description
ProtocolWithdrawServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
abstract ProtocolDocumentBase	administrativelyMarkIncomplete(ProtocolBase protocol, ProtocolAdministrativelyIncompleteBean markIncompleteBean) Perform the task of administratively marking a protocol as 'incomplete'.
abstract ProtocolDocumentBase	administrativelyWithdraw(ProtocolBase protocol, ProtocolAdministrativelyWithdrawBean administrativelyWithdrawBean) Perform the task of administratively withdrawing a protocol.
protected void	cancelWorkflow(ProtocolBase protocol) By canceling the protocol in workflow, we are preventing it from being reviewed by the IRB office.
protected void	generateCorrespondenceDocumentAndAttach(ProtocolBase protocol, ProtocolWithdrawBean withdrawBean) This method will generate a correspondence document, and attach it to the protocol.
protected ProtocolSubmissionBase	getSubmission(ProtocolBase protocol) Get the submission that is being withdrawn.
protected abstract boolean	isAllowedStatus(ProtocolSubmissionBase submission)
protected abstract boolean	isNormalSubmission(ProtocolSubmissionBase submission)
protected boolean	isWithdrawable(ProtocolSubmissionBase submission) A submission is only withdrawable if it corresponds to a request to review the submission.
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Set the business object service.
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Set the document service.
void	setProtocolActionCorrespondenceGenerationService(ProtocolActionCorrespondenceGenerationService protocolActionCorrespondenceGenerationService)
void	setProtocolActionService(ProtocolActionService protocolActionService) Set the ProtocolBase Action Service.
void	setProtocolOnlineReviewService(ProtocolOnlineReviewService protocolOnlineReviewService)
void	setProtocolVersionService(ProtocolVersionService protocolVersionService) Inject ProtocolBase Version Service.
abstract ProtocolDocumentBase	withdraw(ProtocolBase protocol, ProtocolWithdrawBean withdrawBean) Perform the task of withdrawing a protocol.

Methods inherited from class java.lang.Object

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

Field Detail

documentService

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

businessObjectService

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

protocolActionService

protected ProtocolActionService protocolActionService

protocolVersionService

protected ProtocolVersionService protocolVersionService

protocolActionCorrespondenceGenerationService

protected ProtocolActionCorrespondenceGenerationService protocolActionCorrespondenceGenerationService

protocolOnlineReviewService

protected ProtocolOnlineReviewService protocolOnlineReviewService

WITHDRAW_FINALIZE_OLR_ANNOTATION

protected static final String WITHDRAW_FINALIZE_OLR_ANNOTATION

See Also:

Constant Field Values

Constructor Detail

ProtocolWithdrawServiceImplBase

public ProtocolWithdrawServiceImplBase()

Method Detail

setDocumentService

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

Set the document service.

Parameters:

documentService -

setBusinessObjectService

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

Set the business object service.

Parameters:

businessObjectService - the business object service

setProtocolActionCorrespondenceGenerationService

public void setProtocolActionCorrespondenceGenerationService(ProtocolActionCorrespondenceGenerationService protocolActionCorrespondenceGenerationService)

setProtocolActionService

public void setProtocolActionService(ProtocolActionService protocolActionService)

Set the ProtocolBase Action Service.

Parameters:

protocolActionService -

setProtocolVersionService

public void setProtocolVersionService(ProtocolVersionService protocolVersionService)

Inject ProtocolBase Version Service.

Parameters:

protocolVersionService -

withdraw

public abstract ProtocolDocumentBase withdraw(ProtocolBase protocol,
                            ProtocolWithdrawBean withdrawBean)
                                       throws Exception

Description copied from interface: ProtocolWithdrawService

Perform the task of withdrawing a protocol. A new protocol document will be created so that it can be re-submitted into workflow at a later time.

Specified by:

withdraw in interface ProtocolWithdrawService

Parameters:

protocol - the protocol

withdrawBean - the required data for performing a withdrawal

Returns:

new protocol document

Throws:

Exception

generateCorrespondenceDocumentAndAttach

protected void generateCorrespondenceDocumentAndAttach(ProtocolBase protocol,
                                           ProtocolWithdrawBean withdrawBean)
                                                throws PrintingException

This method will generate a correspondence document, and attach it to the protocol.

Parameters:

protocol - a ProtocolBase object.

Throws:

PrintingException

cancelWorkflow

protected void cancelWorkflow(ProtocolBase protocol)
                       throws org.kuali.rice.kew.api.exception.WorkflowException

By canceling the protocol in workflow, we are preventing it from being reviewed by the IRB office. A user will then be able to continue editing the protocol in order to submit it again at a later time.

Parameters:

protocol -

Throws:

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

getSubmission

protected ProtocolSubmissionBase getSubmission(ProtocolBase protocol)

Get the submission that is being withdrawn. Since a protocol can have multiple submissions, go backwards until we find a submission that can be withdrawn

Parameters:

protocol -

Returns:

isWithdrawable

protected boolean isWithdrawable(ProtocolSubmissionBase submission)

A submission is only withdrawable if it corresponds to a request to review the submission. The submissions that meet this criteria are the initial request for review, amendments, and renewals that are still in the pending or submitted to committee states. Submissions such as Notify IRB cannot be withdrawn.

Parameters:

submission -

Returns:

isAllowedStatus

protected abstract boolean isAllowedStatus(ProtocolSubmissionBase submission)

isNormalSubmission

protected abstract boolean isNormalSubmission(ProtocolSubmissionBase submission)

setProtocolOnlineReviewService

public void setProtocolOnlineReviewService(ProtocolOnlineReviewService protocolOnlineReviewService)

administrativelyWithdraw

public abstract ProtocolDocumentBase administrativelyWithdraw(ProtocolBase protocol,
                                            ProtocolAdministrativelyWithdrawBean administrativelyWithdrawBean)
                                                       throws Exception

Description copied from interface: ProtocolWithdrawService

Perform the task of administratively withdrawing a protocol. A new protocol document will be created so that it can be re-submitted into workflow at a later time.

Specified by:

administrativelyWithdraw in interface ProtocolWithdrawService

Parameters:

protocol - the protocol

Returns:

new protocol document

Throws:

Exception

administrativelyMarkIncomplete

public abstract ProtocolDocumentBase administrativelyMarkIncomplete(ProtocolBase protocol,
                                                  ProtocolAdministrativelyIncompleteBean markIncompleteBean)
                                                             throws Exception

Description copied from interface: ProtocolWithdrawService

Perform the task of administratively marking a protocol as 'incomplete'. A new protocol document will be created so that it can be re-submitted into workflow at a later time.

Specified by:

administrativelyMarkIncomplete in interface ProtocolWithdrawService

Parameters:

protocol - the protocol

Returns:

new protocol document

Throws:

Exception