ProtocolCopyServiceImplBase (Kuali Coeus 5.1.1 API)

Constructor Summary

Constructors
Constructor and Description

ProtocolCopyServiceImplBase()

Constructors
Constructor and Description
`ProtocolCopyServiceImplBase()`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`copyAdditionalProperties(GenericProtocolDocument srcDoc, GenericProtocolDocument destDoc)` Copy over the additional properties.
`protected void`	`copyCustomDataAttributeValues(GenericProtocolDocument srcProtocolDocument, GenericProtocolDocument destProtocolDocument)` Copy the custom attribute values to the new protocol document.
`protected void`	`copyOverviewProperties(GenericProtocolDocument src, GenericProtocolDocument dest)` Copies the document overview properties.
`GenericProtocolDocument`	`copyProtocol(GenericProtocolDocument srcDoc)` Copy a protocol document.
`GenericProtocolDocument`	`copyProtocol(GenericProtocolDocument srcDoc, String protocolNumber, boolean isAmendmentRenewal)` Copy a protocol document with a given protocol number.
`protected void`	`copyProtocolLists(GenericProtocolDocument srcDoc, GenericProtocolDocument destDoc)` Copy the BO lists from the original protocol to the new protocol.
`protected void`	`copyRequiredProperties(GenericProtocolDocument srcDoc, GenericProtocolDocument destDoc)` Copy over the required properties so we can do an initial save of the document in order to obtain a ProtocolId and ProtocolNumber.
`protected GenericProtocolDocument`	`createNewProtocol(GenericProtocolDocument srcDoc, String protocolNumber, boolean isAmendmentRenewal)` Create a new protocol based upon a source protocol.
`protected Object`	`deepCopy(Object obj)`
`protected abstract Class<? extends ProtocolActionBase>`	`getProtocolActionBOClassHook()`
`protected abstract ProtocolActionBase`	`getProtocolActionNewInstanceHook(ProtocolBase protocol, ProtocolSubmissionBase protocolSubmission, String protocolActionTypeCode)`
`protected abstract String`	`getProtocolActionProtocolCreatedCodeHook()`
`protected abstract String`	`getProtocolAggregatorHook()`
`protected abstract String`	`getProtocolApproverHook()`
`protected abstract ProtocolNumberServiceBase`	`getProtocolNumberServiceHook()`
`protected abstract String`	`getProtocolRoleTypeHook()`
`protected abstract String`	`getSequenceNumberNameHook()`
`protected void`	`initializeAuthorization(GenericProtocolDocument srcDoc, GenericProtocolDocument destDoc)` Initialize the Authorizations for a new protocol.
`protected void`	`refreshAttachmentsPersonnels(ProtocolBase protocol)`
`void`	`setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)` Set the Document Service.
`void`	`setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)` Set the Kra Authorization Service.
`void`	`setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService)`
`void`	`setSystemAuthorizationService(SystemAuthorizationService systemAuthorizationService)` Set the System Authorization Service.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ProtocolCopyServiceImplBase
```
public ProtocolCopyServiceImplBase()
```
- Method Detail
  - setDocumentService
```
public void setDocumentService(org.kuali.rice.krad.service.DocumentService documentService)
```
    Set the Document Service.
    
    Parameters:
    documentService -
  - setSystemAuthorizationService
```
public void setSystemAuthorizationService(SystemAuthorizationService systemAuthorizationService)
```
    Set the System Authorization Service.
    
    Parameters:
    systemAuthorizationService -
  - setKraAuthorizationService
```
public void setKraAuthorizationService(KraAuthorizationService kraAuthorizationService)
```
    Set the Kra Authorization Service.
    
    Parameters:
    kralAuthorizationService -
  - copyProtocol
```
public GenericProtocolDocument copyProtocol(GenericProtocolDocument srcDoc)
                                                                  throws Exception
```
    Description copied from interface: ProtocolCopyService
    
    Copy a protocol document.
    
    Specified by:
    
    copyProtocol in interface ProtocolCopyService<GenericProtocolDocument extends ProtocolDocumentBase>
    
    Parameters:
    srcDoc - 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
    See Also:
    ProtocolCopyService.copyProtocol(org.kuali.kra.protocol.ProtocolDocumentBase)
  - copyProtocol
```
public GenericProtocolDocument copyProtocol(GenericProtocolDocument srcDoc,
                                   String protocolNumber,
                                   boolean isAmendmentRenewal)
                                                                  throws Exception
```
    Description copied from interface: ProtocolCopyService
    
    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.
    
    Specified by:
    
    copyProtocol in interface ProtocolCopyService<GenericProtocolDocument extends ProtocolDocumentBase>
    
    Parameters:
    srcDoc - 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
    See Also:
    org.kuali.kra.protocol.actions.copy.ProtocolCopyService#copyProtocol(org.kuali.kra.protocol.ProtocolDocumentBase, java.lang.String)
  - createNewProtocol
```
protected GenericProtocolDocument createNewProtocol(GenericProtocolDocument srcDoc,
                                        String protocolNumber,
                                        boolean isAmendmentRenewal)
                                                                          throws Exception
```
    Create a new protocol based upon a source protocol. Only copy over the properties necessary for the initial creation of the protocol. This will give us the protocol number to use when copying over the remainder of the protocol. "Copy" may be a pure copy or copy for amendment & renewal creation. if for amendment/renewal, then notes & attachments will be copied.
    
    Parameters:
    srcDoc -
    
    Returns:
    
    Throws:
    
    Exception
  - refreshAttachmentsPersonnels
```
protected void refreshAttachmentsPersonnels(ProtocolBase protocol)
```
  - copyOverviewProperties
```
protected void copyOverviewProperties(GenericProtocolDocument src,
                          GenericProtocolDocument dest)
```
    Copies the document overview properties. These properties are the Description, Explanation, and Organization Document Number.
    
    Parameters:
    src - the source protocol document, i.e. the original.
    dest - the destination protocol document, i.e. the new document.
  - copyRequiredProperties
```
protected void copyRequiredProperties(GenericProtocolDocument srcDoc,
                          GenericProtocolDocument destDoc)
```
    Copy over the required properties so we can do an initial save of the document in order to obtain a ProtocolId and ProtocolNumber.
    
    Parameters:
    srcDoc -
    destDoc -
  - copyAdditionalProperties
```
protected void copyAdditionalProperties(GenericProtocolDocument srcDoc,
                            GenericProtocolDocument destDoc)
```
    Copy over the additional properties.
    
    Parameters:
    srcDoc -
    destDoc -
  - initializeAuthorization
```
protected void initializeAuthorization(GenericProtocolDocument srcDoc,
                           GenericProtocolDocument destDoc)
```
    Initialize the Authorizations for a new protocol. The initiator/creator is assigned the Aggregator role. We also add in all of the users and their roles. But if we encounter the initiator again, we ignore him/her. For example, the initiator may be a Viewer for the protocol being copied. He/she should not be a Viewer again for the new protocol since they are now have the Aggregator roe.
    
    Parameters:
    doc - the protocol document
  - copyProtocolLists
```
protected void copyProtocolLists(GenericProtocolDocument srcDoc,
                     GenericProtocolDocument destDoc)
```
    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.
    
    Parameters:
    srcDoc -
    destDoc -
  - deepCopy
```
protected Object deepCopy(Object obj)
```
  - copyCustomDataAttributeValues
```
protected void copyCustomDataAttributeValues(GenericProtocolDocument srcProtocolDocument,
                                 GenericProtocolDocument destProtocolDocument)
```
    Copy the custom attribute values to the new protocol document.
    
    Parameters:
    srcProtocolDocument -
    destProtocolDocument -
  - setSequenceAccessorService
```
public void setSequenceAccessorService(org.kuali.rice.krad.service.SequenceAccessorService sequenceAccessorService)
```
  - getProtocolActionBOClassHook
```
protected abstract Class<? extends ProtocolActionBase> getProtocolActionBOClassHook()
```
  - getProtocolActionProtocolCreatedCodeHook
```
protected abstract String getProtocolActionProtocolCreatedCodeHook()
```
  - getSequenceNumberNameHook
```
protected abstract String getSequenceNumberNameHook()
```
  - getProtocolNumberServiceHook
```
protected abstract ProtocolNumberServiceBase getProtocolNumberServiceHook()
```
  - getProtocolActionNewInstanceHook
```
protected abstract ProtocolActionBase getProtocolActionNewInstanceHook(ProtocolBase protocol,
                                                  ProtocolSubmissionBase protocolSubmission,
                                                  String protocolActionTypeCode)
```
  - getProtocolAggregatorHook
```
protected abstract String getProtocolAggregatorHook()
```
  - getProtocolApproverHook
```
protected abstract String getProtocolApproverHook()
```
  - getProtocolRoleTypeHook
```
protected abstract String getProtocolRoleTypeHook()
```

Class ProtocolCopyServiceImplBase<GenericProtocolDocument extends ProtocolDocumentBase>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProtocolCopyServiceImplBase

Method Detail

setDocumentService

setSystemAuthorizationService

setKraAuthorizationService

copyProtocol

copyProtocol

createNewProtocol

refreshAttachmentsPersonnels

copyOverviewProperties

copyRequiredProperties

copyAdditionalProperties

initializeAuthorization

copyProtocolLists

deepCopy

copyCustomDataAttributeValues

setSequenceAccessorService

getProtocolActionBOClassHook

getProtocolActionProtocolCreatedCodeHook

getSequenceNumberNameHook

getProtocolNumberServiceHook

getProtocolActionNewInstanceHook

getProtocolAggregatorHook

getProtocolApproverHook

getProtocolRoleTypeHook