org.kuali.kra.protocol.noteattachment

Class NotesAttachmentsHelperBase

java.lang.Object

org.kuali.kra.protocol.noteattachment.NotesAttachmentsHelperBase

Direct Known Subclasses:

IacucNotesAttachmentsHelper, NotesAttachmentsHelper

public abstract class NotesAttachmentsHelperBase
extends Object

This is the "Helper" class for ProtocolBase Notes And Attachments.

Field Summary

Fields

Modifier and Type	Field and Description
protected TaskAuthorizationService	authService
protected static String	CONFIRM_YES_DELETE_ATTACHMENT_PERSONNEL
protected static String	CONFIRM_YES_DELETE_ATTACHMENT_PROTOCOL
protected static String	CONFIRM_YES_DELETE_NOTE
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected List<AttachmentFile>	FilesToDelete
protected ProtocolFormBase	form
protected KraAuthorizationService	kraAuthorizationService
protected boolean	manageNotesOpen
protected boolean	modifyAttachments
protected boolean	modifyNotepads
protected static String	NAMESPACE
protected ProtocolAttachmentFilterBase	newAttachmentFilter
protected ProtocolAttachmentPersonnelBase	newAttachmentPersonnel
protected ProtocolAttachmentProtocolBase	newAttachmentProtocol
protected ProtocolAttachmentService	notesService
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService
protected ProtocolNotepadBase	protocolNotepad
protected ProtocolNotepadService	protocolNotepadService
protected static String	UNSUPPORTED_ATTACHMENT_TYPE
protected ProtocolAttachmentVersioningUtilityBase	versioningUtil
protected boolean	viewRestricted

Constructor Summary

Constructors

Modifier

Constructor and Description

protected

NotesAttachmentsHelperBase(ProtocolFormBase form, ProtocolAttachmentService notesService, TaskAuthorizationService authService, KraAuthorizationService kraAuthorizationService, org.kuali.rice.core.api.datetime.DateTimeService dateTimeService, ProtocolNotepadService protocolNotepadService, org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService, ProtocolAttachmentVersioningUtilityBase versioningUtil) Constructs a helper.

Method Summary

Methods

Modifier and Type	Method and Description
void	addNewNote() adds a new note to the protocol.
void	addNewProtocolAttachmentFilter()
void	addNewProtocolAttachmentProtocol() Adds the "new" ProtocolAttachmentProtocolBase to the ProtocolBase Document.
abstract boolean	canAddProtocolNotepads() Checks if ProtocolBase Notepads can be modified.
abstract boolean	canEditProtocolAttachments() Checks if ProtocolBase Attachments can be modified.
abstract boolean	canViewRestrictedProtocolNotepads() Checks if restricted ProtocolBase Notepads can be viewed.
protected abstract ProtocolAttachmentFilterBase	createNewProtocolAttachmentFilterInstanceHook()
protected abstract ProtocolAttachmentPersonnelBase	createNewProtocolAttachmentPersonnelInstanceHook(ProtocolBase protocol)
protected abstract ProtocolAttachmentProtocolBase	createNewProtocolAttachmentProtocolInstanceHook(ProtocolBase protocol)
protected abstract ProtocolNotepadBase	createNewProtocolNotepadInstanceHook(ProtocolBase protocol)
<T extends ProtocolAttachmentBase> boolean	deleteExistingAttachmentByType(int attachmentNumber, Class<T> type) Deletes an attachment from a protocol based on a type.
boolean	deleteNote(int noteToDelete) deletes a note from the protocol.
void	fixReloadedAttachments(Map parameterMap) This method...
abstract AddProtocolAttachmentProtocolRule	getAddProtocolAttachmentProtocolRuleInstanceHook()
protected abstract String	getAttachmentDefaultSortKeyHook()
List<AttachmentFile>	getFilesToDelete()
ProtocolAttachmentFilterBase	getNewAttachmentFilter()
ProtocolAttachmentPersonnelBase	getNewAttachmentPersonnel() Gets the new attachment personnel.
ProtocolAttachmentProtocolBase	getNewAttachmentProtocol() Gets the new attachment protocol.
ProtocolNotepadBase	getNewProtocolNotepad() Gets the new protocol notepad.
ProtocolBase	getProtocol() Get the ProtocolBase.
abstract Class<? extends ProtocolAttachmentPersonnelBase>	getProtocolAttachmentPersonnelClassHook()
abstract Class<? extends ProtocolAttachmentProtocolBase>	getProtocolAttachmentProtocolClassHook()
abstract Class<? extends ProtocolDocumentBase>	getProtocolDocumentClassHook()
abstract Class<? extends ProtocolNotepadBase>	getProtocolNotepadClassHook()
protected String	getUserIdentifier() Get the userName of the user for the current session.
boolean	isManageNotesOpen()
boolean	isModifyAttachments() returns whether a protocol can be modified.
boolean	isModifyNotepads() returns whether a protocol can be modified.
abstract boolean	isProtocolAdmin()
boolean	isViewRestricted() returns whether a restricted note can be viewed.
void	modifyNote(int noteToModify) modifies an existing note in the protocol.
void	prepareView() Prepare the tab for viewing.
void	processSave() this method handles logic related to saving attachments.
<T extends ProtocolAttachmentBase> String	retrieveConfirmMethodByType(Class<T> type) Retrieves the confirmation method based on a type.
<T extends ProtocolAttachmentBase> T	retrieveExistingAttachmentByType(int attachmentNumber, Class<T> type) retrieves an attachment from a protocol based on a type.
void	setFilesToDelete(List<AttachmentFile> filesToDelete)
void	setManageNotesOpen(boolean manageNotesOpen)
void	setModifyAttachments(boolean modifyAttachments) sets whether a protocol can be modified.
void	setModifyNotepads(boolean modifyNotepads) sets whether a protocol can be modified.
void	setNewAttachmentFilter(ProtocolAttachmentFilterBase newAttachmentFilter)
void	setNewAttachmentPersonnel(ProtocolAttachmentPersonnelBase newAttachmentPersonnel) Sets the new attachment personnel.
void	setNewAttachmentProtocol(ProtocolAttachmentProtocolBase newAttachmentProtocol) Sets the new attachment protocol.
void	setNewProtocolNotepad(ProtocolNotepadBase protocolNotepad) Sets the new protocol notepad.
void	setViewRestricted(boolean viewRestricted) sets whether a restricted note can be viewed.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE

protected static final String NAMESPACE

See Also:

Constant Field Values

UNSUPPORTED_ATTACHMENT_TYPE

protected static final String UNSUPPORTED_ATTACHMENT_TYPE

See Also:

Constant Field Values

CONFIRM_YES_DELETE_ATTACHMENT_PERSONNEL

protected static final String CONFIRM_YES_DELETE_ATTACHMENT_PERSONNEL

See Also:

Constant Field Values

CONFIRM_YES_DELETE_ATTACHMENT_PROTOCOL

protected static final String CONFIRM_YES_DELETE_ATTACHMENT_PROTOCOL

See Also:

Constant Field Values

CONFIRM_YES_DELETE_NOTE

protected static final String CONFIRM_YES_DELETE_NOTE

See Also:

Constant Field Values

notesService

protected final ProtocolAttachmentService notesService

authService

protected final TaskAuthorizationService authService

kraAuthorizationService

protected final KraAuthorizationService kraAuthorizationService

dateTimeService

protected final org.kuali.rice.core.api.datetime.DateTimeService dateTimeService

protocolNotepadService

protected final ProtocolNotepadService protocolNotepadService

parameterService

protected final org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

versioningUtil

protected final ProtocolAttachmentVersioningUtilityBase versioningUtil

form

protected final ProtocolFormBase form

newAttachmentProtocol

protected ProtocolAttachmentProtocolBase newAttachmentProtocol

newAttachmentPersonnel

protected ProtocolAttachmentPersonnelBase newAttachmentPersonnel

newAttachmentFilter

protected ProtocolAttachmentFilterBase newAttachmentFilter

FilesToDelete

protected List<AttachmentFile> FilesToDelete

protocolNotepad

protected ProtocolNotepadBase protocolNotepad

modifyAttachments

protected boolean modifyAttachments

modifyNotepads

protected boolean modifyNotepads

viewRestricted

protected boolean viewRestricted

manageNotesOpen

protected boolean manageNotesOpen

Constructor Detail

NotesAttachmentsHelperBase

protected NotesAttachmentsHelperBase(ProtocolFormBase form,
                          ProtocolAttachmentService notesService,
                          TaskAuthorizationService authService,
                          KraAuthorizationService kraAuthorizationService,
                          org.kuali.rice.core.api.datetime.DateTimeService dateTimeService,
                          ProtocolNotepadService protocolNotepadService,
                          org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService,
                          ProtocolAttachmentVersioningUtilityBase versioningUtil)

Constructs a helper.

Parameters:

form - the form

notesService - the notesService

authService - the authService

versioningUtil - the versioning util

Throws:

IllegalArgumentException - if the form, notesService, authService, or versioningUtil is null

Method Detail

prepareView

public void prepareView()

Prepare the tab for viewing.

canEditProtocolAttachments

public abstract boolean canEditProtocolAttachments()

Checks if ProtocolBase Attachments can be modified.

Returns:

true if can be modified false if cannot

getUserIdentifier

protected String getUserIdentifier()

Get the userName of the user for the current session.

Returns:

the current session's userName

getProtocol

public ProtocolBase getProtocol()

Get the ProtocolBase.

Returns:

the ProtocolBase

Throws:

IllegalArgumentException - if the ProtocolDocumentBase or ProtocolBase is null.

getNewAttachmentProtocol

public ProtocolAttachmentProtocolBase getNewAttachmentProtocol()

Gets the new attachment protocol. This method will not return null. Also, The ProtocolAttachmentProtocolBase should have a valid protocol Id at this point.

Returns:

the new attachment protocol

setNewAttachmentProtocol

public void setNewAttachmentProtocol(ProtocolAttachmentProtocolBase newAttachmentProtocol)

Sets the new attachment protocol.

Parameters:

newAttachmentProtocol - the new attachment protocol

getNewAttachmentPersonnel

public ProtocolAttachmentPersonnelBase getNewAttachmentPersonnel()

Gets the new attachment personnel. This method will not return null. Also, The ProtocolAttachmentPersonnelBase should have a valid protocol Id at this point.

Returns:

the new attachment personnel

setNewAttachmentPersonnel

public void setNewAttachmentPersonnel(ProtocolAttachmentPersonnelBase newAttachmentPersonnel)

Sets the new attachment personnel.

Parameters:

newAttachmentPersonnel - the new attachment personnel

isModifyAttachments

public boolean isModifyAttachments()

returns whether a protocol can be modified.

Returns:

true if modification is allowed false if not.

setModifyAttachments

public void setModifyAttachments(boolean modifyAttachments)

sets whether a protocol can be modified.

Parameters:

modifyAttachments - true if modification is allowed false if not.

processSave

public void processSave()

this method handles logic related to saving attachments. Since multiple attachments can change on a single save, this method must handle all attachment types.

fixReloadedAttachments

public void fixReloadedAttachments(Map parameterMap)

This method...

Parameters:

parameterMap -

addNewProtocolAttachmentProtocol

public void addNewProtocolAttachmentProtocol()

Adds the "new" ProtocolAttachmentProtocolBase to the ProtocolBase Document. Before adding this method executes validation. If the validation fails the attachment is not added.

getAddProtocolAttachmentProtocolRuleInstanceHook

public abstract AddProtocolAttachmentProtocolRule getAddProtocolAttachmentProtocolRuleInstanceHook()

deleteExistingAttachmentByType

public <T extends ProtocolAttachmentBase> boolean deleteExistingAttachmentByType(int attachmentNumber,
                                                                        Class<T> type)

Deletes an attachment from a protocol based on a type.

Type Parameters:

T - the type parameter

Parameters:

attachmentNumber - the attachment number

type - the type token

Returns:

true if successfully deleted.

Throws:

IllegalArgumentException - if the type is null or not recognized

retrieveExistingAttachmentByType

public <T extends ProtocolAttachmentBase> T retrieveExistingAttachmentByType(int attachmentNumber,
                                                                    Class<T> type)

retrieves an attachment from a protocol based on a type.

Type Parameters:

T - the type parameter

Parameters:

attachmentNumber - the attachment number

type - the type token

Returns:

the attachment or null if not found

Throws:

IllegalArgumentException - if the type is null or not recognized

retrieveConfirmMethodByType

public <T extends ProtocolAttachmentBase> String retrieveConfirmMethodByType(Class<T> type)

Retrieves the confirmation method based on a type. This method is highly coupled to the corresponding Action class. This method is here in order to keep the "ByType" methods together.

Type Parameters:

T - the type parameter

Parameters:

type - the type token

Returns:

the confirmation method

Throws:

IllegalArgumentException - if the type is null or not recognized

createNewProtocolAttachmentProtocolInstanceHook

protected abstract ProtocolAttachmentProtocolBase createNewProtocolAttachmentProtocolInstanceHook(ProtocolBase protocol)

createNewProtocolAttachmentPersonnelInstanceHook

protected abstract ProtocolAttachmentPersonnelBase createNewProtocolAttachmentPersonnelInstanceHook(ProtocolBase protocol)

createNewProtocolAttachmentFilterInstanceHook

protected abstract ProtocolAttachmentFilterBase createNewProtocolAttachmentFilterInstanceHook()

getAttachmentDefaultSortKeyHook

protected abstract String getAttachmentDefaultSortKeyHook()

getFilesToDelete

public List<AttachmentFile> getFilesToDelete()

setFilesToDelete

public void setFilesToDelete(List<AttachmentFile> filesToDelete)

canAddProtocolNotepads

public abstract boolean canAddProtocolNotepads()

Checks if ProtocolBase Notepads can be modified.

Returns:

true if can be modified false if cannot

canViewRestrictedProtocolNotepads

public abstract boolean canViewRestrictedProtocolNotepads()

Checks if restricted ProtocolBase Notepads can be viewed.

Returns:

true if can be modified false if cannot

getNewProtocolNotepad

public ProtocolNotepadBase getNewProtocolNotepad()

Gets the new protocol notepad. This method will not return null. Also, The ProtocolAttachmentProtocolBase should have a valid protocol Id at this point.

Returns:

the new protocol notepad

setNewProtocolNotepad

public void setNewProtocolNotepad(ProtocolNotepadBase protocolNotepad)

Sets the new protocol notepad.

Parameters:

protocolNotepad - the new protocol notepad

isModifyNotepads

public boolean isModifyNotepads()

returns whether a protocol can be modified.

Returns:

true if modification is allowed false if not.

setModifyNotepads

public void setModifyNotepads(boolean modifyNotepads)

sets whether a protocol can be modified.

Parameters:

modifyNotepads - true if modification is allowed false if not.

isViewRestricted

public boolean isViewRestricted()

returns whether a restricted note can be viewed.

Returns:

true if viewing is allowed false if not.

setViewRestricted

public void setViewRestricted(boolean viewRestricted)

sets whether a restricted note can be viewed.

Parameters:

viewRestricted - true if viewing is allowed false if not.

isProtocolAdmin

public abstract boolean isProtocolAdmin()

addNewNote

public void addNewNote()

adds a new note to the protocol. Also performs validation.

modifyNote

public void modifyNote(int noteToModify)

modifies an existing note in the protocol.

deleteNote

public boolean deleteNote(int noteToDelete)

deletes a note from the protocol.

setManageNotesOpen

public void setManageNotesOpen(boolean manageNotesOpen)

isManageNotesOpen

public boolean isManageNotesOpen()

getNewAttachmentFilter

public ProtocolAttachmentFilterBase getNewAttachmentFilter()

setNewAttachmentFilter

public void setNewAttachmentFilter(ProtocolAttachmentFilterBase newAttachmentFilter)

addNewProtocolAttachmentFilter

public void addNewProtocolAttachmentFilter()

getProtocolAttachmentProtocolClassHook

public abstract Class<? extends ProtocolAttachmentProtocolBase> getProtocolAttachmentProtocolClassHook()

getProtocolAttachmentPersonnelClassHook

public abstract Class<? extends ProtocolAttachmentPersonnelBase> getProtocolAttachmentPersonnelClassHook()

getProtocolNotepadClassHook

public abstract Class<? extends ProtocolNotepadBase> getProtocolNotepadClassHook()

getProtocolDocumentClassHook

public abstract Class<? extends ProtocolDocumentBase> getProtocolDocumentClassHook()

createNewProtocolNotepadInstanceHook

protected abstract ProtocolNotepadBase createNewProtocolNotepadInstanceHook(ProtocolBase protocol)