org.kuali.kra.protocol

Class ProtocolVersionServiceImplBase

java.lang.Object

org.kuali.kra.protocol.ProtocolVersionServiceImplBase

All Implemented Interfaces:

ProtocolVersionService

Direct Known Subclasses:

IacucProtocolVersionServiceImpl, ProtocolVersionServiceImpl

public abstract class ProtocolVersionServiceImplBase
extends Object
implements ProtocolVersionService

ProtocolBase Version Service Implementation.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected VersioningService	versioningService

Constructor Summary

Constructors

Constructor and Description
ProtocolVersionServiceImplBase()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkCollection(List<? extends org.kuali.rice.krad.bo.PersistableBusinessObject> bos)
protected void	copyCustomDataAttributeValues(ProtocolDocumentBase protocolDocument, ProtocolDocumentBase newProtocolDocument) The Custom Data Attribute values are stored in the document.
protected abstract ProtocolDocumentBase	createNewProtocolDocumentInstanceHook()
protected abstract ProtocolBase	createProtocolNewVersionHook(ProtocolBase protocol)
protected void	finalizeAttachmentProtocol(ProtocolBase protocol)
protected void	fixActionSequenceNumbers(ProtocolBase protocol, ProtocolBase newProtocol) The Versioning Service increments all of the sequence numbers.
protected void	fixNextValues(ProtocolDocumentBase oldDoc, ProtocolDocumentBase newDoc) The document next values must be the same in the new version as in the old document.
protected abstract ProtocolModuleQuestionnaireBeanBase	getNewInstanceProtocolModuleQuestionnaireBeanHook(ProtocolBase protocol)
protected ProtocolDocumentBase	getNewProtocolDocument()
protected abstract Class<? extends ProtocolBase>	getProtocolBOClassHook()
protected abstract String	getProtocolDocumentTypeHook()
protected abstract String	getProtocolSequenceIdHook()
ProtocolBase	getProtocolVersion(String protocolNumber, Integer sequenceNumber) Get a particular version of a protocol.
protected void	materializeCollections(ProtocolBase protocol)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDocumentService(org.kuali.rice.krad.service.DocumentService documentService) Inject the Document Service.
void	setQuestionnaireAnswerService(QuestionnaireAnswerService questionnaireAnswerService)
void	setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService)
void	setSessionDocumentService(org.kuali.rice.kns.service.SessionDocumentService sessionDocumentService)
void	setVersioningService(VersioningService versioningService) Inject the Versioning Service.
void	setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)
ProtocolDocumentBase	versionProtocolDocument(ProtocolDocumentBase protocolDocument) Create a new version of a protocol document.

Methods inherited from class java.lang.Object

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

Field Detail

businessObjectService

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

versioningService

protected VersioningService versioningService

Constructor Detail

ProtocolVersionServiceImplBase

public ProtocolVersionServiceImplBase()

Method Detail

setDocumentService

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

Inject the Document Service.

Parameters:

documentService -

setBusinessObjectService

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

setSessionDocumentService

public void setSessionDocumentService(org.kuali.rice.kns.service.SessionDocumentService sessionDocumentService)

setVersioningService

public void setVersioningService(VersioningService versioningService)

Inject the Versioning Service.

Parameters:

versioningService -

getProtocolDocumentTypeHook

protected abstract String getProtocolDocumentTypeHook()

getNewProtocolDocument

protected ProtocolDocumentBase getNewProtocolDocument()
                                               throws Exception

Throws:

Exception

createNewProtocolDocumentInstanceHook

protected abstract ProtocolDocumentBase createNewProtocolDocumentInstanceHook()

createProtocolNewVersionHook

protected abstract ProtocolBase createProtocolNewVersionHook(ProtocolBase protocol)
                                                      throws Exception

Throws:

Exception

versionProtocolDocument

public ProtocolDocumentBase versionProtocolDocument(ProtocolDocumentBase protocolDocument)
                                             throws Exception

Description copied from interface: ProtocolVersionService

Create a new version of a protocol document.

Specified by:

versionProtocolDocument in interface ProtocolVersionService

Parameters:

protocolDocument - the protocol document to version

Returns:

the new versioned protocol document

Throws:

Exception

See Also:

ProtocolVersionService.versionProtocolDocument(org.kuali.kra.protocol.ProtocolDocumentBase)

getProtocolSequenceIdHook

protected abstract String getProtocolSequenceIdHook()

materializeCollections

protected void materializeCollections(ProtocolBase protocol)

checkCollection

protected void checkCollection(List<? extends org.kuali.rice.krad.bo.PersistableBusinessObject> bos)

finalizeAttachmentProtocol

protected void finalizeAttachmentProtocol(ProtocolBase protocol)

copyCustomDataAttributeValues

protected void copyCustomDataAttributeValues(ProtocolDocumentBase protocolDocument,
                                 ProtocolDocumentBase newProtocolDocument)

The Custom Data Attribute values are stored in the document. Unfortunately, the Versioning Service doesn't version documents, only BOs. Thus, after the versioning is complete, this method will copy the custom data attribute values over to the new document.

Parameters:

protocolDocument -

newProtocolDocument -

fixActionSequenceNumbers

protected void fixActionSequenceNumbers(ProtocolBase protocol,
                            ProtocolBase newProtocol)

The Versioning Service increments all of the sequence numbers. This is incorrect for ProtocolBase Actions. The original sequence numbers must be maintained. Therefore, they are restored from the original protocol.

Parameters:

protocol -

newProtocol -

fixNextValues

protected void fixNextValues(ProtocolDocumentBase oldDoc,
                 ProtocolDocumentBase newDoc)

The document next values must be the same in the new version as in the old document. Note that the next document values must be assigned the document number of the new version.

Parameters:

oldDoc -

newDoc -

getProtocolVersion

public ProtocolBase getProtocolVersion(String protocolNumber,
                              Integer sequenceNumber)

Description copied from interface: ProtocolVersionService

Get a particular version of a protocol.

Specified by:

getProtocolVersion in interface ProtocolVersionService

Returns:

See Also:

ProtocolVersionService.getProtocolVersion(java.lang.String, java.lang.Integer)

getProtocolBOClassHook

protected abstract Class<? extends ProtocolBase> getProtocolBOClassHook()

setQuestionnaireAnswerService

public void setQuestionnaireAnswerService(QuestionnaireAnswerService questionnaireAnswerService)

setSequenceAccessorService

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

setWorkflowDocumentService

public void setWorkflowDocumentService(org.kuali.rice.krad.workflow.service.WorkflowDocumentService workflowDocumentService)

getNewInstanceProtocolModuleQuestionnaireBeanHook

protected abstract ProtocolModuleQuestionnaireBeanBase getNewInstanceProtocolModuleQuestionnaireBeanHook(ProtocolBase protocol)