org.kuali.kra.proposaldevelopment.bo

Class Narrative

java.lang.Object

org.kuali.rice.krad.bo.BusinessObjectBase

org.kuali.rice.krad.bo.PersistableBusinessObjectBase

org.kuali.kra.bo.KraPersistableBusinessObjectBase

org.kuali.kra.proposaldevelopment.bo.Narrative

All Implemented Interfaces:

Serializable, org.apache.ojb.broker.PersistenceBrokerAware, KcAttachment, HierarchyMaintainable, 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 Narrative
extends KraPersistableBusinessObjectBase
implements HierarchyMaintainable, KcAttachment

This class is BO for narrarive

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
Narrative()

Method Summary

Methods

Modifier and Type	Method and Description
List	buildListOfDeletionAwareLists()
void	clearAttachment()
boolean	equals(Object obj)
protected String	findLoggedInUserPersonId()
String	getComments()
String	getContactName()
String	getContentType()
byte[]	getData() Returns the data of this attachment
boolean	getDeleteAttachment(String userId) Can the current user delete the attachment?
boolean	getDownloadAttachment(String userId) Can the current user download (view) the attachment?
String	getEmailAddress()
String	getFileName()
String	getHierarchyProposalNumber() Gets the hierarchyProposalNumber attribute.
String	getIconPath() Return the image file path based on mime type or other criteria.
String	getInstitutionalAttachmentTypeCode() This method is to return institutional attachment type.
boolean	getModifyNarrativeRights(String userId) Can the current user modify the user rights for the attachment?
Integer	getModuleNumber()
Integer	getModuleSequenceNumber()
String	getModuleStatusCode()
String	getModuleTitle()
String	getName() Returns file name of the attached file.
List<NarrativeAttachment>	getNarrativeAttachmentList()
org.apache.struts.upload.FormFile	getNarrativeFile()
NarrativeStatus	getNarrativeStatus() Gets the narrativeStatus attribute.
NarrativeType	getNarrativeType()
String	getNarrativeTypeCode()
NarrativeUserRights	getNarrativeUserRight(int index) Gets index i from the narrativeUserRights list.
List<NarrativeUserRights>	getNarrativeUserRights()
String	getPhoneNumber()
String	getProposalNumber()
boolean	getReplaceAttachment(String userId) Can the current user replace the attachment?
Timestamp	getTimestampDisplay()
String	getType() Returns the mime type of the attachment.
String	getUploadUserDisplay()
String	getUploadUserFullName()
int	hashCode()
int	hierarchyHashCode()
boolean	isHiddenInHierarchy() Gets the hiddenInHierarchy attribute.
void	populateAttachment() This method used to populate the attachment to narrative object by reading FormFile
void	setComments(String comments)
void	setContactName(String contactName)
void	setContentType(String contentType)
void	setEmailAddress(String emailAddress)
void	setFileName(String fileName)
void	setHiddenInHierarchy(boolean hiddenInHierarchy) Sets the hiddenInHierarchy attribute value.
void	setHierarchyProposalNumber(String hierarchyProposalNumber) Sets the hierarchyProposalNumber attribute value.
void	setInstitutionalAttachmentTypeCode(String institutionalAttachmentTypeCode) This method set the institutional attachment type.
void	setModuleNumber(Integer moduleNumber)
void	setModuleSequenceNumber(Integer moduleSequenceNumber)
void	setModuleStatusCode(String moduleStatusCode)
void	setModuleTitle(String moduleTitle)
void	setNarrativeAttachmentList(List<NarrativeAttachment> narrativePdfList)
void	setNarrativeFile(org.apache.struts.upload.FormFile narrativeFile)
void	setNarrativeStatus(NarrativeStatus narrativeStatus) Sets the narrativeStatus attribute value.
void	setNarrativeType(NarrativeType narrativeType)
void	setNarrativeTypeCode(String narrativeTypeCode)
void	setNarrativeUserRights(List<NarrativeUserRights> narrativeUserRights)
void	setPhoneNumber(String phoneNumber)
void	setProposalNumber(String proposalNumber)
void	setTimestampDisplay(Timestamp timestampDisplay)
void	setUploadUserDisplay(String uploadUserDisplay)
void	setUploadUserFullName(String uploadUserFullName)

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, 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.rice.core.api.mo.ModelObjectBasic

toString

Constructor Detail

Narrative

public Narrative()

Method Detail

findLoggedInUserPersonId

protected String findLoggedInUserPersonId()

getModuleNumber

public Integer getModuleNumber()

setModuleNumber

public void setModuleNumber(Integer moduleNumber)

getProposalNumber

public String getProposalNumber()

setProposalNumber

public void setProposalNumber(String proposalNumber)

getComments

public String getComments()

setComments

public void setComments(String comments)

getContactName

public String getContactName()

setContactName

public void setContactName(String contactName)

getEmailAddress

public String getEmailAddress()

setEmailAddress

public void setEmailAddress(String emailAddress)

getModuleSequenceNumber

public Integer getModuleSequenceNumber()

setModuleSequenceNumber

public void setModuleSequenceNumber(Integer moduleSequenceNumber)

getModuleStatusCode

public String getModuleStatusCode()

setModuleStatusCode

public void setModuleStatusCode(String moduleStatusCode)

getModuleTitle

public String getModuleTitle()

setModuleTitle

public void setModuleTitle(String moduleTitle)

getNarrativeTypeCode

public String getNarrativeTypeCode()

setNarrativeTypeCode

public void setNarrativeTypeCode(String narrativeTypeCode)

getPhoneNumber

public String getPhoneNumber()

setPhoneNumber

public void setPhoneNumber(String phoneNumber)

getNarrativeType

public NarrativeType getNarrativeType()

setNarrativeType

public void setNarrativeType(NarrativeType narrativeType)

getNarrativeUserRights

public List<NarrativeUserRights> getNarrativeUserRights()

setNarrativeUserRights

public void setNarrativeUserRights(List<NarrativeUserRights> narrativeUserRights)

getNarrativeStatus

public NarrativeStatus getNarrativeStatus()

Gets the narrativeStatus attribute.

Returns:

Returns the narrativeStatus.

setNarrativeStatus

public void setNarrativeStatus(NarrativeStatus narrativeStatus)

Sets the narrativeStatus attribute value.

Parameters:

narrativeStatus - The narrativeStatus to set.

getNarrativeAttachmentList

public List<NarrativeAttachment> getNarrativeAttachmentList()

setNarrativeAttachmentList

public void setNarrativeAttachmentList(List<NarrativeAttachment> narrativePdfList)

getNarrativeFile

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

setNarrativeFile

public void setNarrativeFile(org.apache.struts.upload.FormFile narrativeFile)

getFileName

public String getFileName()

setFileName

public void setFileName(String fileName)

getInstitutionalAttachmentTypeCode

public String getInstitutionalAttachmentTypeCode()

This method is to return institutional attachment type. This column does not exist in table. Basically, it is for narrativetypecode in table.

Returns:

setInstitutionalAttachmentTypeCode

public void setInstitutionalAttachmentTypeCode(String institutionalAttachmentTypeCode)

This method set the institutional attachment type. Since instituteattachmenttypecode is set as 'required' in DD. So, it is set to narrativetypecode, and hence to return narrative type code.

Parameters:

institutionalAttachmentTypeCode -

getDownloadAttachment

public boolean getDownloadAttachment(String userId)

Can the current user download (view) the attachment?

Parameters:

username -

Returns:

true if the user can view the attachment; otherwise false

getReplaceAttachment

public boolean getReplaceAttachment(String userId)

Can the current user replace the attachment?

Returns:

true if the user can replace the attachment; otherwise false

getDeleteAttachment

public boolean getDeleteAttachment(String userId)

Can the current user delete the attachment?

Returns:

true if the user can delete the attachment; otherwise false

getModifyNarrativeRights

public boolean getModifyNarrativeRights(String userId)

Can the current user modify the user rights for the attachment?

Returns:

true if the user can modify the user rights; otherwise false

populateAttachment

public void populateAttachment()

This method used to populate the attachment to narrative object by reading FormFile

getNarrativeUserRight

public NarrativeUserRights getNarrativeUserRight(int index)

Gets index i from the narrativeUserRights list.

Parameters:

index -

Returns:

Question at index i

clearAttachment

public void clearAttachment()

buildListOfDeletionAwareLists

public List buildListOfDeletionAwareLists()

Specified by:

buildListOfDeletionAwareLists in interface org.kuali.rice.krad.bo.PersistableBusinessObject

Overrides:

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(java.lang.Object)

hierarchyHashCode

public int hierarchyHashCode()

getTimestampDisplay

public Timestamp getTimestampDisplay()

setTimestampDisplay

public void setTimestampDisplay(Timestamp timestampDisplay)

getUploadUserDisplay

public String getUploadUserDisplay()

setUploadUserDisplay

public void setUploadUserDisplay(String uploadUserDisplay)

getUploadUserFullName

public String getUploadUserFullName()

setUploadUserFullName

public void setUploadUserFullName(String uploadUserFullName)

getHierarchyProposalNumber

public String getHierarchyProposalNumber()

Gets the hierarchyProposalNumber attribute.

Specified by:

getHierarchyProposalNumber in interface HierarchyMaintainable

Returns:

Returns the hierarchyProposalNumber.

setHierarchyProposalNumber

public void setHierarchyProposalNumber(String hierarchyProposalNumber)

Sets the hierarchyProposalNumber attribute value.

Specified by:

setHierarchyProposalNumber in interface HierarchyMaintainable

Parameters:

hierarchyProposalNumber - The hierarchyProposalNumber to set.

isHiddenInHierarchy

public boolean isHiddenInHierarchy()

Gets the hiddenInHierarchy attribute.

Specified by:

isHiddenInHierarchy in interface HierarchyMaintainable

Returns:

Returns the hiddenInHierarchy.

setHiddenInHierarchy

public void setHiddenInHierarchy(boolean hiddenInHierarchy)

Sets the hiddenInHierarchy attribute value.

Specified by:

setHiddenInHierarchy in interface HierarchyMaintainable

Parameters:

hiddenInHierarchy - The hiddenInHierarchy to set.

getContentType

public String getContentType()

setContentType

public void setContentType(String contentType)

getData

public byte[] getData()

Description copied from interface: KcAttachment

Returns the data of this attachment

Specified by:

getData in interface KcAttachment

Returns:

getIconPath

public String getIconPath()

Description copied from interface: KcAttachment

Return the image file path based on mime type or other criteria.

Specified by:

getIconPath in interface KcAttachment

Returns:

getName

public String getName()

Description copied from interface: KcAttachment

Returns file name of the attached file.

Specified by:

getName in interface KcAttachment

Returns:

getType

public String getType()

Description copied from interface: KcAttachment

Returns the mime type of the attachment.

Specified by:

getType in interface KcAttachment

Returns: