org.kuali.kra.iacuc.actions.copy

Class IacucProtocolCopyServiceImpl

java.lang.Object

org.kuali.kra.protocol.actions.copy.ProtocolCopyServiceImplBase<IacucProtocolDocument>

org.kuali.kra.iacuc.actions.copy.IacucProtocolCopyServiceImpl

All Implemented Interfaces:

IacucProtocolCopyService, ProtocolCopyService<IacucProtocolDocument>

public class IacucProtocolCopyServiceImpl
extends ProtocolCopyServiceImplBase<IacucProtocolDocument>
implements IacucProtocolCopyService

Constructor Summary

Constructors

Constructor and Description
IacucProtocolCopyServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addProtocolExceptions(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy protocol exceptions
protected void	addProtocolProcedures(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy protocol procedures
protected void	addProtocolSpecies(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy protocol species Return a map of old species and current species id.
protected void	addThreeRs(IacucProtocol srcProtocol, IacucProtocol destProtocol)
protected void	copyIacucProtocolLists(IacucProtocol srcProtocol, IacucProtocol destProtocol)
void	copyIacucProtocolModules(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy iacuc specific data list from source protocol to destination protocol
void	copyProtocolExceptions(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy source exceptions to destination protocol
protected void	copyProtocolLists(IacucProtocolDocument srcDoc, IacucProtocolDocument destDoc) Copy the BO lists from the original protocol to the new protocol.
void	copyProtocolProcedures(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy source procedures to destination protocol We need to replace the old protocol species id with the new one which was handled through copyProtocolSpeciesAndGroups
void	copyProtocolSpeciesAndGroups(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy source species and groups to destination protocol Here new protocol species id will be generated for all new records.
void	copyProtocolThreers(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to copy source threers data to destination protocol
protected void	copyRequiredProperties(IacucProtocolDocument srcDoc, IacucProtocolDocument destDoc) Copy over the required properties so we can do an initial save of the document in order to obtain a ProtocolId and ProtocolNumber.
IacucProtocolExceptionService	getIacucProtocolExceptionService()
IacucProtocolProcedureService	getIacucProtocolProcedureService()
IacucProtocolSpeciesService	getIacucProtocolSpeciesService()
protected HashMap<Integer,Integer>	getNewProtocolSpeciesMap(IacucProtocol protocol)
protected Class<? extends ProtocolActionBase>	getProtocolActionBOClassHook()
protected IacucProtocolAction	getProtocolActionNewInstanceHook(ProtocolBase protocol, ProtocolSubmissionBase protocolSubmission, String protocolActionTypeCode)
protected String	getProtocolActionProtocolCreatedCodeHook()
protected String	getProtocolAggregatorHook()
protected String	getProtocolApproverHook()
protected IacucProtocolNumberService	getProtocolNumberServiceHook()
protected String	getProtocolRoleTypeHook()
protected String	getSequenceNumberNameHook()
void	mergeProtocolProcedures(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to merge protocol procedures.
protected void	mergeProtocolSpecies(IacucProtocolSpecies srcProtocolSpecies, IacucProtocolSpecies dstProtocolSpecies) This method is to merge source species with destination species
void	mergeProtocolSpeciesAndGroups(IacucProtocol srcProtocol, IacucProtocol destProtocol) This method is to merge species during amendment and renewal with amendment.
void	setIacucProtocolExceptionService(IacucProtocolExceptionService iacucProtocolExceptionService)
void	setIacucProtocolProcedureService(IacucProtocolProcedureService iacucProtocolProcedureService)
void	setIacucProtocolSpeciesService(IacucProtocolSpeciesService iacucProtocolSpeciesService)

Methods inherited from class org.kuali.kra.protocol.actions.copy.ProtocolCopyServiceImplBase

copyAdditionalProperties, copyCustomDataAttributeValues, copyOverviewProperties, copyProtocol, copyProtocol, createNewProtocol, deepCopy, initializeAuthorization, refreshAttachmentsPersonnels, setDocumentService, setKraAuthorizationService, setSequenceAccessorService, setSystemAuthorizationService

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.kra.protocol.actions.copy.ProtocolCopyService

copyProtocol, copyProtocol

Constructor Detail

IacucProtocolCopyServiceImpl

public IacucProtocolCopyServiceImpl()

Method Detail

copyIacucProtocolModules

public void copyIacucProtocolModules(IacucProtocol srcProtocol,
                            IacucProtocol destProtocol)

Description copied from interface: IacucProtocolCopyService

This method is to copy iacuc specific data list from source protocol to destination protocol

Specified by:

copyIacucProtocolModules in interface IacucProtocolCopyService

getProtocolActionBOClassHook

protected Class<? extends ProtocolActionBase> getProtocolActionBOClassHook()

Specified by:

getProtocolActionBOClassHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

getProtocolActionProtocolCreatedCodeHook

protected String getProtocolActionProtocolCreatedCodeHook()

Specified by:

getProtocolActionProtocolCreatedCodeHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

getSequenceNumberNameHook

protected String getSequenceNumberNameHook()

Specified by:

getSequenceNumberNameHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

copyRequiredProperties

protected void copyRequiredProperties(IacucProtocolDocument srcDoc,
                          IacucProtocolDocument destDoc)

Description copied from class: ProtocolCopyServiceImplBase

Copy over the required properties so we can do an initial save of the document in order to obtain a ProtocolId and ProtocolNumber.

Overrides:

copyRequiredProperties in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

copyProtocolLists

protected void copyProtocolLists(IacucProtocolDocument srcDoc,
                     IacucProtocolDocument destDoc)

Description copied from class: ProtocolCopyServiceImplBase

Copy the BO lists from the original protocol to the new protocol. The init() method for each BO entry will be invoked to reset its primary key (id), ProtocolId, and ProtocolNumber.

Overrides:

copyProtocolLists in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

copyIacucProtocolLists

protected void copyIacucProtocolLists(IacucProtocol srcProtocol,
                          IacucProtocol destProtocol)

addThreeRs

protected void addThreeRs(IacucProtocol srcProtocol,
              IacucProtocol destProtocol)

copyProtocolThreers

public void copyProtocolThreers(IacucProtocol srcProtocol,
                       IacucProtocol destProtocol)

Description copied from interface: IacucProtocolCopyService

This method is to copy source threers data to destination protocol

Specified by:

copyProtocolThreers in interface IacucProtocolCopyService

See Also:

IacucProtocolCopyService.copyIacucProtocolModules(org.kuali.kra.iacuc.IacucProtocol, org.kuali.kra.iacuc.IacucProtocol)

copyProtocolSpeciesAndGroups

public void copyProtocolSpeciesAndGroups(IacucProtocol srcProtocol,
                                IacucProtocol destProtocol)

Description copied from interface: IacucProtocolCopyService

This method is to copy source species and groups to destination protocol Here new protocol species id will be generated for all new records. We need to set the old reference id in protocol species. There is a link in procedure to protocol species id. So when we copy procedure data, we can replace old protocol species id with new one.

Specified by:

copyProtocolSpeciesAndGroups in interface IacucProtocolCopyService

See Also:

IacucProtocolCopyService.copyProtocolSpeciesAndGroups(org.kuali.kra.iacuc.IacucProtocol, org.kuali.kra.iacuc.IacucProtocol)

copyProtocolProcedures

public void copyProtocolProcedures(IacucProtocol srcProtocol,
                          IacucProtocol destProtocol)

Description copied from interface: IacucProtocolCopyService

This method is to copy source procedures to destination protocol We need to replace the old protocol species id with the new one which was handled through copyProtocolSpeciesAndGroups

Specified by:

copyProtocolProcedures in interface IacucProtocolCopyService

See Also:

IacucProtocolCopyService.copyProtocolProcedures(org.kuali.kra.iacuc.IacucProtocol, org.kuali.kra.iacuc.IacucProtocol)

copyProtocolExceptions

public void copyProtocolExceptions(IacucProtocol srcProtocol,
                          IacucProtocol destProtocol)

Description copied from interface: IacucProtocolCopyService

This method is to copy source exceptions to destination protocol

Specified by:

copyProtocolExceptions in interface IacucProtocolCopyService

See Also:

IacucProtocolCopyService.copyProtocolExceptions(org.kuali.kra.iacuc.IacucProtocol, org.kuali.kra.iacuc.IacucProtocol)

addProtocolSpecies

protected void addProtocolSpecies(IacucProtocol srcProtocol,
                      IacucProtocol destProtocol)

This method is to copy protocol species Return a map of old species and current species id. This mapping is required when new set of procedures are created where it is linked to protocol species id.

Parameters:

sourceProtocolSpecies -

destDoc -

mergeProtocolSpeciesAndGroups

public void mergeProtocolSpeciesAndGroups(IacucProtocol srcProtocol,
                                 IacucProtocol destProtocol)

Description copied from interface: IacucProtocolCopyService

This method is to merge species during amendment and renewal with amendment. A deep copy alone is causing issue at this point since there is reference in procedure panel for these protocol species. So when removed from the list is causing referential constraint violation. This is a work around for now until we figure out a change to handle protocol species and procedures. Here PK is retained and other informations are merged for existing species and any new species are added while species removed in amendment are removed from original.

Specified by:

mergeProtocolSpeciesAndGroups in interface IacucProtocolCopyService

See Also:

IacucProtocolCopyService.mergeProtocolSpeciesAndGroups(org.kuali.kra.iacuc.IacucProtocol, org.kuali.kra.iacuc.IacucProtocol)

mergeProtocolSpecies

protected void mergeProtocolSpecies(IacucProtocolSpecies srcProtocolSpecies,
                        IacucProtocolSpecies dstProtocolSpecies)

This method is to merge source species with destination species

Parameters:

srcProtocolSpecies -

dstProtocolSpecies -

getNewProtocolSpeciesMap

protected HashMap<Integer,Integer> getNewProtocolSpeciesMap(IacucProtocol protocol)

addProtocolExceptions

protected void addProtocolExceptions(IacucProtocol srcProtocol,
                         IacucProtocol destProtocol)

This method is to copy protocol exceptions

Parameters:

sourceProtocolExceptions -

destDoc -

mergeProtocolProcedures

public void mergeProtocolProcedures(IacucProtocol srcProtocol,
                           IacucProtocol destProtocol)

Description copied from interface: IacucProtocolCopyService

This method is to merge protocol procedures. We need to set reference for the new protocol species since it we create a new version.

Specified by:

mergeProtocolProcedures in interface IacucProtocolCopyService

addProtocolProcedures

protected void addProtocolProcedures(IacucProtocol srcProtocol,
                         IacucProtocol destProtocol)

This method is to copy protocol procedures

Parameters:

sourceProtocolProcedures -

destDoc -

speciesIdMapping -

getProtocolNumberServiceHook

protected IacucProtocolNumberService getProtocolNumberServiceHook()

Specified by:

getProtocolNumberServiceHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

getProtocolActionNewInstanceHook

protected IacucProtocolAction getProtocolActionNewInstanceHook(ProtocolBase protocol,
                                                   ProtocolSubmissionBase protocolSubmission,
                                                   String protocolActionTypeCode)

Specified by:

getProtocolActionNewInstanceHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

getProtocolAggregatorHook

protected String getProtocolAggregatorHook()

Specified by:

getProtocolAggregatorHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

getProtocolApproverHook

protected String getProtocolApproverHook()

Specified by:

getProtocolApproverHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

getProtocolRoleTypeHook

protected String getProtocolRoleTypeHook()

Specified by:

getProtocolRoleTypeHook in class ProtocolCopyServiceImplBase<IacucProtocolDocument>

getIacucProtocolSpeciesService

public IacucProtocolSpeciesService getIacucProtocolSpeciesService()

setIacucProtocolSpeciesService

public void setIacucProtocolSpeciesService(IacucProtocolSpeciesService iacucProtocolSpeciesService)

getIacucProtocolExceptionService

public IacucProtocolExceptionService getIacucProtocolExceptionService()

setIacucProtocolExceptionService

public void setIacucProtocolExceptionService(IacucProtocolExceptionService iacucProtocolExceptionService)

getIacucProtocolProcedureService

public IacucProtocolProcedureService getIacucProtocolProcedureService()

setIacucProtocolProcedureService

public void setIacucProtocolProcedureService(IacucProtocolProcedureService iacucProtocolProcedureService)