org.kuali.kra.protocol.noteattachment

Class ProtocolAttachmentBase

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.protocol.ProtocolAssociateBase

org.kuali.kra.protocol.noteattachment.ProtocolAttachmentBase

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, TypedAttachment, Sequenceable, SequenceAssociate<ProtocolBase>, org.kuali.rice.core.api.mo.common.GloballyUnique, org.kuali.rice.core.api.mo.common.Versioned, org.kuali.rice.core.api.mo.ModelObjectBasic, org.kuali.rice.krad.bo.BusinessObject, org.kuali.rice.krad.bo.PersistableBusinessObject

Direct Known Subclasses:

ProtocolAttachmentPersonnelBase, ProtocolAttachmentProtocolBase

public abstract class ProtocolAttachmentBase
extends ProtocolAssociateBase
implements TypedAttachment

This is the base class for all ProtocolBase Attachments.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolAttachmentBase.PropertyName Contains all the property names in this class.

Field Summary

Fields inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

UPDATE_USER_LENGTH

Fields inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

extension, versionNumber

Constructor Summary

Constructors

Constructor and Description
ProtocolAttachmentBase() empty ctor to satisfy JavaBean convention.
ProtocolAttachmentBase(ProtocolBase protocol) Convenience ctor to set the protocol, protocol id and the protocolNumber from the passed in protocol.

Method Summary

Methods

Modifier and Type	Method and Description
static <T extends ProtocolAttachmentBase> void	addAttachmentToCollection(T attachment, Collection<T> toCollection) Adds an attachment to a Collection.
boolean	equals(Object obj)
static <T extends ProtocolAttachmentBase> Collection<T>	filterExistingAttachments(Collection<T> attachments) Returns a new collection containing only exiting attachments.
static <T extends ProtocolAttachmentBase> Collection<T>	filterNewAttachments(Collection<T> attachments) Returns a new collection containing only new attachments.
abstract String	getAttachmentDescription() A human readable description of the attachment type.
Integer	getDocumentId() Gets the Document Id.
AttachmentFile	getFile() Gets the ProtocolBase Attachment Base File.
Long	getFileId() Gets the file Id.
Long	getId() Gets the id.
org.apache.struts.upload.FormFile	getNewFile() Gets the ProtocolBase Attachment Base New File.
String	getUpdateUserFullName() Gets the updateUserFullName attribute.
int	hashCode()
boolean	isNew() Checks if an attachment is new (not persisted yet).
static <T extends ProtocolAttachmentBase> void	removeAttachmentFromCollection(T attachment, Collection<T> fromCollection) Adds an attachment to a Collection.
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setDocumentId(Integer documentId) Sets the Document Id.
void	setFile(AttachmentFile file) Sets the ProtocolBase Attachment Base File.
void	setFileId(Long fileId) Sets the file Id.
void	setId(Long id) Sets the id.
void	setNewFile(org.apache.struts.upload.FormFile newFile) Sets the ProtocolBase Attachment Base New File.
void	setUpdateUserFullName(String updateUserFullName) Sets the updateUserFullName attribute value.
abstract boolean	supportsVersioning() Method to check whether an attachment supports versioning.

Methods inherited from class org.kuali.kra.protocol.ProtocolAssociateBase

getProtocol, getProtocolId, getProtocolNumber, getSequenceNumber, getSequenceOwner, init, postInitHook, setProtocol, setProtocolId, setProtocolNumber, setSequenceNumber, setSequenceOwner

Methods inherited from class org.kuali.kra.bo.KraPersistableBusinessObjectBase

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, prePersist, preUpdate, setUpdateTimestamp, setUpdateUser, setUpdateUserSet

Methods inherited from class org.kuali.rice.krad.bo.PersistableBusinessObjectBase

afterDelete, afterInsert, afterLookup, afterUpdate, beforeDelete, beforeInsert, beforeUpdate, buildListOfDeletionAwareLists, getExtension, getObjectId, getPersistenceService, getPersistenceStructureService, getVersionNumber, isNewCollectionRecord, linkEditableUserFields, postLoad, postRemove, postUpdate, preRemove, refresh, refreshNonUpdateableReferences, refreshReferenceObject, setExtension, setNewCollectionRecord, setObjectId, setVersionNumber

Methods inherited from class org.kuali.rice.krad.bo.BusinessObjectBase

toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.kuali.kra.protocol.noteattachment.TypedAttachment

getDescription, getGroupCode, getType, getTypeCode, setDescription, setType, setTypeCode

Methods inherited from interface org.kuali.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

ProtocolAttachmentBase

public ProtocolAttachmentBase()

empty ctor to satisfy JavaBean convention.

ProtocolAttachmentBase

public ProtocolAttachmentBase(ProtocolBase protocol)

Convenience ctor to set the protocol, protocol id and the protocolNumber from the passed in protocol.

This ctor does not validate any of the properties.

Parameters:

protocol - the protocol.

Method Detail

getFile

public AttachmentFile getFile()

Gets the ProtocolBase Attachment Base File.

Returns:

the ProtocolBase Attachment Base File

setFile

public void setFile(AttachmentFile file)

Sets the ProtocolBase Attachment Base File.

Parameters:

file - the ProtocolBase Attachment Base File

getNewFile

public org.apache.struts.upload.FormFile getNewFile()

Gets the ProtocolBase Attachment Base New File.

Returns:

the ProtocolBase Attachment Base New File

setNewFile

public void setNewFile(org.apache.struts.upload.FormFile newFile)

Sets the ProtocolBase Attachment Base New File.

Parameters:

newFile - the ProtocolBase Attachment Base New File

getFileId

public Long getFileId()

Gets the file Id.

Returns:

the file Id.

setFileId

public void setFileId(Long fileId)

Sets the file Id.

Parameters:

fileId - the file Id.

getAttachmentDescription

public abstract String getAttachmentDescription()

A human readable description of the attachment type.

Returns:

a description

resetPersistenceState

public void resetPersistenceState()

This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity. During sequencing, the VersioningService needs to be able to signal that a Sequenceable has changed state from an persisted entity to a new, unpersisted one. Otherwise, versioning operations would result earlier SequenceOwners losing the association with older versions of associates. This behavior comes into play whenever an associated object is versioned. Typically, implementers will set primary key fields to null to trigger an INSERT during save.

Specified by:

resetPersistenceState in interface Sequenceable

getId

public Long getId()

Gets the id.

Returns:

the id

setId

public void setId(Long id)

Sets the id.

Parameters:

id - the id

addAttachmentToCollection

public static <T extends ProtocolAttachmentBase> void addAttachmentToCollection(T attachment,
                                                                Collection<T> toCollection)

Adds an attachment to a Collection.

Type Parameters:

T - the type of attachment

Parameters:

attachment - the attachment.

toCollection - the Collection.

Throws:

IllegalArgumentException - if the attachment or the list is null.

removeAttachmentFromCollection

public static <T extends ProtocolAttachmentBase> void removeAttachmentFromCollection(T attachment,
                                                                     Collection<T> fromCollection)

Adds an attachment to a Collection.

Type Parameters:

T - the type of attachment

Parameters:

attachment - the attachment.

fromCollection - the Collection.

Throws:

IllegalArgumentException - if the attachment or the list is null.

isNew

public boolean isNew()

Checks if an attachment is new (not persisted yet).

Returns:

true if new false if not

filterNewAttachments

public static <T extends ProtocolAttachmentBase> Collection<T> filterNewAttachments(Collection<T> attachments)

Returns a new collection containing only new attachments.

Type Parameters:

T - the type of attachments in the collection.

Parameters:

attachments - the current collection

Returns:

an collection containing only new attachments

filterExistingAttachments

public static <T extends ProtocolAttachmentBase> Collection<T> filterExistingAttachments(Collection<T> attachments)

Returns a new collection containing only exiting attachments.

Type Parameters:

T - the type of attachments in the collection.

Parameters:

attachments - the current collection

Returns:

an collection containing only exiting attachments

supportsVersioning

public abstract boolean supportsVersioning()

Method to check whether an attachment supports versioning. Currently, all attachments have structural capabilities to version; however, currently we are not versioning all attachment types to be consistent with other parts of KC.

Returns:

true is attachment supports versioning.

hashCode

public int hashCode()

Overrides:

hashCode in class ProtocolAssociateBase

equals

public boolean equals(Object obj)

Overrides:

equals in class ProtocolAssociateBase

getDocumentId

public Integer getDocumentId()

Description copied from interface: TypedAttachment

Gets the Document Id. The document id is used to allow multiple typed attachments to exist. So two attachments of the same type will have different document numbers.

Specified by:

getDocumentId in interface TypedAttachment

Returns:

the Document Id

setDocumentId

public void setDocumentId(Integer documentId)

Description copied from interface: TypedAttachment

Sets the Document Id.

Specified by:

setDocumentId in interface TypedAttachment

Parameters:

documentId - the Document Id

See Also:

TypedAttachment.getDocumentId()

getUpdateUserFullName

public String getUpdateUserFullName()

Gets the updateUserFullName attribute.

Returns:

Returns the updateUserFullName.

setUpdateUserFullName

public void setUpdateUserFullName(String updateUserFullName)

Sets the updateUserFullName attribute value.

Parameters:

updateUserFullName - The updateUserFullName to set.