org.kuali.kra.award.notesandattachments.attachments

Class AwardAttachment

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.award.AwardAssociate

org.kuali.kra.award.notesandattachments.attachments.AwardAttachment

All Implemented Interfaces:

Serializable, Comparable<AwardAttachment>, org.apache.ojb.broker.PersistenceBrokerAware, Sequenceable, SequenceAssociate<Award>, 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

public class AwardAttachment
extends AwardAssociate
implements Comparable<AwardAttachment>

This class...

See Also:

Serialized Form

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
AwardAttachment() empty ctor to satisfy JavaBean convention.
AwardAttachment(Award award) Convenience ctor to add the protocol as an owner.

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(AwardAttachment o) Implements comparable based on the awardAttachmentId.
boolean	equals(Object obj)
String	getAttachmentDescription()
Long	getAwardAttachmentId() Gets the id.
AwardAttachmentType	getAwardAttachmentType() Gets the type attribute.
Long	getAwardId() Gets the awardId attribute.
String	getDescription()
Integer	getDocumentId()
AttachmentFile	getFile() Gets the Award Attachment File.
Long	getFileId() Gets the file Id.
org.apache.struts.upload.FormFile	getNewFile() Gets the Award Attachment New File.
AwardAttachmentType	getType() Gets the type attribute.
String	getTypeCode()
String	getUpdateUserName() This method returns the full name of the update user.
int	hashCode()
boolean	isNew() Checks if an attachment is new (not persisted yet).
protected void	preRemove()
protected void	preUpdate()
void	resetPersistenceState() This method resets the persistence state used to establish whether this is a new entity or an already-persisted entity.
void	setAwardAttachmentId(Long awardAttachmentId) Sets the id.
void	setAwardId(Long awardId) Sets the awardId attribute value.
void	setDescription(String description)
void	setDocumentId(Integer documentId)
void	setFile(AttachmentFile file) Sets the Award Attachment File.
void	setFileId(Long fileId) Sets the file Id.
void	setNewFile(org.apache.struts.upload.FormFile newFile) Sets the Award Attachment New File.
void	setType(AwardAttachmentType type) Sets the type attribute value.
void	setTypeCode(String typeCode)
void	setUpdateTimestamp(Timestamp updateTimestamp) This sets the update time stamp only if it hasn't already been set.
boolean	supportsVersioning()

Methods inherited from class org.kuali.kra.award.AwardAssociate

getAward, getAwardNumber, getSequenceNumber, getSequenceOwner, prePersist, setAward, setAwardNumber, setSequenceNumber, setSequenceOwner

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

getAuthorPersonName, getKcPersonService, getUpdateTimestamp, getUpdateUser, isUpdateUserSet, postPersist, 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, 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.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

AwardAttachment

public AwardAttachment()

empty ctor to satisfy JavaBean convention.

AwardAttachment

public AwardAttachment(Award award)

Convenience ctor to add the protocol as an owner.

This ctor does not validate any of the properties.

Parameters:

protocol - the protocol.

Method Detail

getAwardId

public Long getAwardId()

Gets the awardId attribute.

Returns:

Returns the awardId.

setAwardId

public void setAwardId(Long awardId)

Sets the awardId attribute value.

Parameters:

awardId - The awardId to set.

getTypeCode

public String getTypeCode()

setTypeCode

public void setTypeCode(String typeCode)

getDocumentId

public Integer getDocumentId()

setDocumentId

public void setDocumentId(Integer documentId)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getAttachmentDescription

public String getAttachmentDescription()

getFile

public AttachmentFile getFile()

Gets the Award Attachment File.

setFile

public void setFile(AttachmentFile file)

Sets the Award Attachment File.

getNewFile

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

Gets the Award Attachment New File.

Returns:

the Award Attachment New File

setNewFile

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

Sets the Award Attachment New File.

Parameters:

newFile - the Award Attachment 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.

getAwardAttachmentId

public Long getAwardAttachmentId()

Gets the id.

Returns:

the id

setAwardAttachmentId

public void setAwardAttachmentId(Long awardAttachmentId)

Sets the id.

Parameters:

id - the id

getAwardAttachmentType

public AwardAttachmentType getAwardAttachmentType()

Gets the type attribute.

Returns:

Returns the type.

getType

public AwardAttachmentType getType()

Gets the type attribute.

Returns:

Returns the type.

setType

public void setType(AwardAttachmentType type)

Sets the type attribute value.

Parameters:

type - The type to set.

supportsVersioning

public boolean supportsVersioning()

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. also nulling the person id because when saving after versioning, the person id is reverting to the wrong BO.

Specified by:

resetPersistenceState in interface Sequenceable

isNew

public boolean isNew()

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

Returns:

true if new false if not

hashCode

public int hashCode()

Overrides:

hashCode in class AwardAssociate

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class AwardAssociate

See Also:

Object.equals(java.lang.Object)

preUpdate

protected void preUpdate()

Overrides:

preUpdate in class KraPersistableBusinessObjectBase

See Also:

PersistableBusinessObjectBase.beforeUpdate(org.apache.ojb.broker.PersistenceBroker)

getUpdateUserName

public String getUpdateUserName()

This method returns the full name of the update user.

Returns:

setUpdateTimestamp

public void setUpdateTimestamp(Timestamp updateTimestamp)

This sets the update time stamp only if it hasn't already been set.

Overrides:

setUpdateTimestamp in class KraPersistableBusinessObjectBase

See Also:

KraPersistableBusinessObjectBase.setUpdateTimestamp(java.sql.Timestamp)

compareTo

public int compareTo(AwardAttachment o)

Implements comparable based on the awardAttachmentId.

Specified by:

compareTo in interface Comparable<AwardAttachment>

See Also:

Comparable.compareTo(java.lang.Object)

preRemove

protected void preRemove()

Overrides:

preRemove in class org.kuali.rice.krad.bo.PersistableBusinessObjectBase