org.kuali.kra.protocol.noteattachment

Class ProtocolAttachmentVersioningUtilityBase

java.lang.Object

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentVersioningUtilityBase

Direct Known Subclasses:

IacucProtocolAttachmentVersioningUtility, ProtocolAttachmentVersioningUtility

public abstract class ProtocolAttachmentVersioningUtilityBase
extends Object

Class used for versioning protocol attachments.

The basic algorithm for versioning is the following:

1. check if versioning is required
2. version the File BO
3. associate the new File version with an "existing" Attachment BO
4. create a new ProtocolBase Document
5. version the ProtocolBase and all its BOs which includes all attachment BOs (that are referencing the new file BO)
6. set the new ProtocolBase Document w/ the new ProtocolBase version
7. set the struts form to reference the new ProtocolBase Document

It was easier to create the version of the file before the version of the ProtocolBase to allow for easy updating of file references. Also, versioning of the ProtocolBase naturally only needs to happen once, at the end of this process.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ATTACHMENT_DELETED
protected static String	ATTACHMENT_DRAFTED
protected org.kuali.rice.krad.service.DocumentService	docService
protected ProtocolFormBase	form
protected ProtocolDocumentBase	newDocumentVersion
protected ProtocolAttachmentService	notesService
protected VersioningService	versionService

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ProtocolAttachmentVersioningUtilityBase(ProtocolFormBase form, ProtocolAttachmentService notesService, VersioningService versionService, org.kuali.rice.krad.service.DocumentService docService) Constructs a versioning util.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract Class<? extends ProtocolAttachmentProtocolBase>	getProtocolAttachmentProtocolClassHook()
protected <T extends ProtocolAttachmentBase> boolean	versionExstingAttachments(Collection<ProtocolAttachmentProtocolBase> attachments, Class<? extends ProtocolAttachmentProtocolBase> class1) Versions all attachments for a given Collection of attachments on the protocol.

Methods inherited from class java.lang.Object

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

Field Detail

notesService

protected final ProtocolAttachmentService notesService

versionService

protected final VersioningService versionService

docService

protected final org.kuali.rice.krad.service.DocumentService docService

form

protected final ProtocolFormBase form

ATTACHMENT_DELETED

protected static final String ATTACHMENT_DELETED

See Also:

Constant Field Values

ATTACHMENT_DRAFTED

protected static final String ATTACHMENT_DRAFTED

See Also:

Constant Field Values

newDocumentVersion

protected ProtocolDocumentBase newDocumentVersion

Constructor Detail

ProtocolAttachmentVersioningUtilityBase

protected ProtocolAttachmentVersioningUtilityBase(ProtocolFormBase form,
                                       ProtocolAttachmentService notesService,
                                       VersioningService versionService,
                                       org.kuali.rice.krad.service.DocumentService docService)

Constructs a versioning util.

Parameters:

form - the form

notesService - the notesService

versionService - the versionService

docService - the docService

Throws:

IllegalArgumentException - if the form, notesService, versionService, or docService is null

Method Detail

versionExstingAttachments

protected <T extends ProtocolAttachmentBase> boolean versionExstingAttachments(Collection<ProtocolAttachmentProtocolBase> attachments,
                                                                   Class<? extends ProtocolAttachmentProtocolBase> class1)

Versions all attachments for a given Collection of attachments on the protocol. Any changes done on a passed in attachment will effectively be reverted to what is in the database and those changes will be reflected in a new attachment & protocol version. The passed in Collection or objects in Collection may be modified. the type of attachments

Parameters:

attachments - the attachments.

class1 - the class token for type of attachments (required for adding to generic Collection)

getProtocolAttachmentProtocolClassHook

protected abstract Class<? extends ProtocolAttachmentProtocolBase> getProtocolAttachmentProtocolClassHook()