org.kuali.kra.protocol.noteattachment

Interface ProtocolAttachmentService

All Known Subinterfaces:

IacucProtocolAttachmentService, ProtocolAttachmentService

All Known Implementing Classes:

IacucProtocolAttachmentServiceImpl, ProtocolAttachmentServiceImpl, ProtocolAttachmentServiceImplBase

public interface ProtocolAttachmentService

Contains the methods used for ProtocolBase Notes and Attachments.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteAttatchment(ProtocolAttachmentBase attachment) Deletes an existing ProtocolAttachmentBase.
<T extends ProtocolAttachmentBase> T	getAttachment(Class<T> type, Long id) Retrieves an attachment from the database of a given type based on the attachment id.
<T extends ProtocolAttachmentBase & TypedAttachment> Collection<T>	getAttachmentsWithOlderFileVersions(T attachment, Class<T> type) Deletes an existing ProtocolAttachmentBase.
ProtocolPersonBase	getPerson(Integer personId) Gets a Person BO from personId.
ProtocolAttachmentStatusBase	getStatusFromCode(String code) Gets a ProtocolAttachmentStatus from a code.
ProtocolAttachmentTypeBase	getTypeFromCode(String code) Gets a ProtocolAttachmentType from a code.
Collection<ProtocolAttachmentTypeBase>	getTypesForGroup(String code) Gets a Collection of ProtocolAttachmentType from a group code.
boolean	isAttachmentActive(ProtocolAttachmentProtocolBase attachment) This method will check if the given attachment is currently active (for the active version of the protocol it is attached to).
boolean	isNewAttachmentVersion(ProtocolAttachmentProtocolBase attachment) This method is to check if the attachment is the new version,ie, the first version.
boolean	isSharedFile(ProtocolAttachmentPersonnelBase attachment) This method is to check whether the attachment file is shared by old version of attachments.
void	saveAttatchment(ProtocolAttachmentBase attachment) Saves (persists) an ProtocolAttachmentBase.
void	setProtocolAttachmentUpdateUsersName(List<? extends ProtocolAttachmentBase> protocolAttachmentBases) Populate the updateUserFullName transient field in each ProtocolAttachmentBase object in the list.

Method Detail

getTypeFromCode

ProtocolAttachmentTypeBase getTypeFromCode(String code)

Gets a ProtocolAttachmentType from a code.

Parameters:

code - the code.

Returns:

the ProtocolAttachmentType. If the code is not found then null is returned.

Throws:

IllegalArgumentException - if the code is null

getTypesForGroup

Collection<ProtocolAttachmentTypeBase> getTypesForGroup(String code)

Gets a Collection of ProtocolAttachmentType from a group code.

Parameters:

code - the group code.

Returns:

a Collection of ProtocolAttachmentType. If no codes are found then an empty Collection is returned.

Throws:

IllegalArgumentException - if the code is null

getStatusFromCode

ProtocolAttachmentStatusBase getStatusFromCode(String code)

Gets a ProtocolAttachmentStatus from a code.

Parameters:

code - the code.

Returns:

the ProtocolAttachmentStatus. If the code is not found then null is returned.

Throws:

IllegalArgumentException - if the code is null

saveAttatchment

void saveAttatchment(ProtocolAttachmentBase attachment)

Saves (persists) an ProtocolAttachmentBase. This method will modify the passed in attachment setting any missing properties. It also saves all BOs that the attachment contains (ex. the File).

Parameters:

attachment - the attachment.

Throws:

IllegalArgumentException - if the attachment or attachment's new file is null

deleteAttatchment

void deleteAttatchment(ProtocolAttachmentBase attachment)

Deletes an existing ProtocolAttachmentBase. It will also delete any child BOs that should also be removed (ex. the File).

Parameters:

attachment - the attachment.

Throws:

IllegalArgumentException - if the attachment or attachment's new file is null

getAttachment

<T extends ProtocolAttachmentBase> T getAttachment(Class<T> type,
                                                 Long id)

Retrieves an attachment from the database of a given type based on the attachment id.

Type Parameters:

T - the type

Parameters:

type - the class token for the type

id - the attachment id

Returns:

the attachment or null if not found.

Throws:

IllegalArgumentException - if the type or id is null

getPerson

ProtocolPersonBase getPerson(Integer personId)

Gets a Person BO from personId.

Parameters:

personId - the person id

Returns:

the BO

Throws:

IllegalArgumentException - if the code or type is null.

getAttachmentsWithOlderFileVersions

<T extends ProtocolAttachmentBase & TypedAttachment> Collection<T> getAttachmentsWithOlderFileVersions(T attachment,
                                                                                                    Class<T> type)

Deletes an existing ProtocolAttachmentBase. It will also delete any child BOs that should also be removed (ex. the File).

Unlike other methods in the service, passing an invalid attachment will just result in an empty Collection being returned.

Type Parameters:

T - the type of attachment - only certain types can have "versions" according to what KC recognizes as a version

Parameters:

attachment - the attachment.

type - a class token for the type

Returns:

a Collection of attachments

isNewAttachmentVersion

boolean isNewAttachmentVersion(ProtocolAttachmentProtocolBase attachment)

This method is to check if the attachment is the new version,ie, the first version.

Parameters:

attachment -

Returns:

isAttachmentActive

boolean isAttachmentActive(ProtocolAttachmentProtocolBase attachment)

This method will check if the given attachment is currently active (for the active version of the protocol it is attached to).

Parameters:

attachment -

Returns:

isSharedFile

boolean isSharedFile(ProtocolAttachmentPersonnelBase attachment)

This method is to check whether the attachment file is shared by old version of attachments.

Parameters:

attachment -

Returns:

setProtocolAttachmentUpdateUsersName

void setProtocolAttachmentUpdateUsersName(List<? extends ProtocolAttachmentBase> protocolAttachmentBases)

Populate the updateUserFullName transient field in each ProtocolAttachmentBase object in the list.

Parameters:

protocolAttachmentBases - The list of ProtocolAttachementBase objects you wish to populate the updateUserFullName field on.