org.kuali.kra.protocol.noteattachment

Class ProtocolAttachmentServiceImplBase

java.lang.Object

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentServiceImplBase

All Implemented Interfaces:

ProtocolAttachmentService

Direct Known Subclasses:

IacucProtocolAttachmentServiceImpl, ProtocolAttachmentServiceImpl

public abstract class ProtocolAttachmentServiceImplBase
extends Object
implements ProtocolAttachmentService

Implementation of ProtocolNoteAndAttachmentService.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	boService
protected org.apache.commons.logging.Log	LOG
protected org.kuali.rice.kim.api.identity.PersonService	personService
protected ProtocolDao	protocolDao

Constructor Summary

Constructors

Constructor and Description
ProtocolAttachmentServiceImplBase(org.kuali.rice.krad.service.BusinessObjectService boService, ProtocolDao protocolDao) Constructor than sets the dependencies.

Method Summary

Methods

Modifier and Type	Method and Description
void	deleteAttatchment(ProtocolAttachmentBase attachment) Deletes an existing ProtocolAttachmentBase.
protected ProtocolBase	getActiveProtocol(String protocolNumber)
<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.
protected <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> T	getCodeType(Class<T> type, String code) Gets a "code" BO from a code.
ProtocolPersonBase	getPerson(Integer personId) Gets a Person BO from personId.
abstract Class<? extends ProtocolAttachmentPersonnelBase>	getProtocolAttachmentPersonnelClassHook()
abstract Class<? extends ProtocolAttachmentProtocolBase>	getProtocolAttachmentProtocolClassHook()
abstract Class<? extends ProtocolAttachmentStatusBase>	getProtocolAttachmentStatusClassHook()
abstract Class<? extends ProtocolAttachmentTypeBase>	getProtocolAttachmentTypeClassHook()
abstract Class<? extends ProtocolAttachmentTypeGroupBase>	getProtocolAttachmentTypeGroupClassHook()
abstract Class<? extends ProtocolBase>	getProtocolClassHook()
abstract Class<? extends ProtocolPersonBase>	getProtocolPersonClassHook()
ProtocolAttachmentStatusBase	getStatusFromCode(String code) Gets a ProtocolAttachmentStatus from a code.
ProtocolAttachmentTypeBase	getTypeFromCode(String code) Gets a ProtocolAttachmentType from a code.
abstract 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	setPersonService(org.kuali.rice.kim.api.identity.PersonService personService) Sets the personService attribute value.
void	setProtocolAttachmentUpdateUsersName(List<? extends ProtocolAttachmentBase> protocolAttachmentBases) Populate the updateUserFullName transient field in each ProtocolAttachmentBase object in the list.

Methods inherited from class java.lang.Object

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

Field Detail

boService

protected final org.kuali.rice.krad.service.BusinessObjectService boService

protocolDao

protected final ProtocolDao protocolDao

personService

protected org.kuali.rice.kim.api.identity.PersonService personService

LOG

protected final org.apache.commons.logging.Log LOG

Constructor Detail

ProtocolAttachmentServiceImplBase

public ProtocolAttachmentServiceImplBase(org.kuali.rice.krad.service.BusinessObjectService boService,
                                 ProtocolDao protocolDao)

Constructor than sets the dependencies.

Parameters:

boService - the BusinessObjectService

Throws:

IllegalArgumentException - if the boService or protocolDao is null

Method Detail

getProtocolClassHook

public abstract Class<? extends ProtocolBase> getProtocolClassHook()

getProtocolAttachmentStatusClassHook

public abstract Class<? extends ProtocolAttachmentStatusBase> getProtocolAttachmentStatusClassHook()

getProtocolPersonClassHook

public abstract Class<? extends ProtocolPersonBase> getProtocolPersonClassHook()

getProtocolAttachmentTypeClassHook

public abstract Class<? extends ProtocolAttachmentTypeBase> getProtocolAttachmentTypeClassHook()

getProtocolAttachmentTypeGroupClassHook

public abstract Class<? extends ProtocolAttachmentTypeGroupBase> getProtocolAttachmentTypeGroupClassHook()

getProtocolAttachmentProtocolClassHook

public abstract Class<? extends ProtocolAttachmentProtocolBase> getProtocolAttachmentProtocolClassHook()

getProtocolAttachmentPersonnelClassHook

public abstract Class<? extends ProtocolAttachmentPersonnelBase> getProtocolAttachmentPersonnelClassHook()

getStatusFromCode

public ProtocolAttachmentStatusBase getStatusFromCode(String code)

Gets a ProtocolAttachmentStatus from a code.

Specified by:

getStatusFromCode in interface ProtocolAttachmentService

Parameters:

code - the code.

Returns:

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

getTypeFromCode

public ProtocolAttachmentTypeBase getTypeFromCode(String code)

Gets a ProtocolAttachmentType from a code.

Specified by:

getTypeFromCode in interface ProtocolAttachmentService

Parameters:

code - the code.

Returns:

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

getTypesForGroup

public abstract Collection<ProtocolAttachmentTypeBase> getTypesForGroup(String code)

Description copied from interface: ProtocolAttachmentService

Gets a Collection of ProtocolAttachmentType from a group code.

Specified by:

getTypesForGroup in interface ProtocolAttachmentService

Parameters:

code - the group code.

Returns:

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

saveAttatchment

public 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).

Specified by:

saveAttatchment in interface ProtocolAttachmentService

Parameters:

attachment - the attachment.

deleteAttatchment

public void deleteAttatchment(ProtocolAttachmentBase attachment)

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

Specified by:

deleteAttatchment in interface ProtocolAttachmentService

Parameters:

attachment - the attachment.

getPerson

public ProtocolPersonBase getPerson(Integer personId)

Gets a Person BO from personId.

Specified by:

getPerson in interface ProtocolAttachmentService

Parameters:

personId - the person id

Returns:

the BO

getAttachment

public <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.

Specified by:

getAttachment in interface ProtocolAttachmentService

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.

isNewAttachmentVersion

public boolean isNewAttachmentVersion(ProtocolAttachmentProtocolBase attachment)

Description copied from interface: ProtocolAttachmentService

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

Specified by:

isNewAttachmentVersion in interface ProtocolAttachmentService

Returns:

See Also:

ProtocolAttachmentService.isNewAttachmentVersion(org.kuali.kra.protocol.noteattachment.ProtocolAttachmentProtocolBase)

isAttachmentActive

public boolean isAttachmentActive(ProtocolAttachmentProtocolBase attachment)

Description copied from interface: ProtocolAttachmentService

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

Specified by:

isAttachmentActive in interface ProtocolAttachmentService

Returns:

getActiveProtocol

protected ProtocolBase getActiveProtocol(String protocolNumber)

getAttachmentsWithOlderFileVersions

public <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.

Specified by:

getAttachmentsWithOlderFileVersions in interface ProtocolAttachmentService

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

getCodeType

protected <T extends org.kuali.rice.krad.bo.PersistableBusinessObject> T getCodeType(Class<T> type,
                                                                         String code)

Gets a "code" BO from a code. This method will only work for a BO that has a property of "code" that is the primary key.

Type Parameters:

T - the BO type

Parameters:

type - the type

code - the code value

Returns:

the BO

Throws:

IllegalArgumentException - if the code or type is null.

isSharedFile

public boolean isSharedFile(ProtocolAttachmentPersonnelBase attachment)

Description copied from interface: ProtocolAttachmentService

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

Specified by:

isSharedFile in interface ProtocolAttachmentService

Returns:

See Also:

ProtocolAttachmentService.isSharedFile(org.kuali.kra.protocol.noteattachment.ProtocolAttachmentPersonnelBase)

setProtocolAttachmentUpdateUsersName

public void setProtocolAttachmentUpdateUsersName(List<? extends ProtocolAttachmentBase> protocolAttachmentBases)

Description copied from interface: ProtocolAttachmentService

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

Specified by:

setProtocolAttachmentUpdateUsersName in interface ProtocolAttachmentService

Parameters:

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

See Also:

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentService#setProtocolAttachmentPersonnelUpdateUsersName(java.util.List)

setPersonService

public void setPersonService(org.kuali.rice.kim.api.identity.PersonService personService)

Sets the personService attribute value.

Parameters:

personService - The personService to set.