org.kuali.kra.proposaldevelopment.service

Interface NarrativeService

All Known Implementing Classes:

NarrativeServiceImpl

public interface NarrativeService

This class...

Method Summary

Methods

Modifier and Type	Method and Description
void	addInstituteAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument, Narrative narrative)
void	addNarrative(ProposalDevelopmentDocument proposaldevelopmentDocument, Narrative narrative)
void	addPerson(String userId, ProposalDevelopmentDocument proposalDevelopmentDocument, String roleName) Add a person to all of the Narratives in a proposal.
void	deleteInstitutionalAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument, int lineToDelete)
void	deletePerson(String userId, ProposalDevelopmentDocument proposalDevelopmentDocument) Delete a person from all of the narratives.
void	deleteProposalAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument, int lineToDelete)
void	populateNarrativeRightsForLoggedinUser(ProposalDevelopmentDocument proposaldevelopmentDocument)
void	populatePersonNameForNarrativeUserRights(ProposalDevelopmentDocument proposaldevelopmentDocument, Narrative narrative)
void	readjustRights(String userId, ProposalDevelopmentDocument proposalDevelopmentDocument, List<String> roleNames) Re-adjust the narrative rights for a user.
void	replaceAttachment(Narrative narrative)
void	setNarrativeTimeStampUser(List<Narrative> narratives) This method set up timestamp and upload user for narrative & internal attachments.

Method Detail

addNarrative

void addNarrative(ProposalDevelopmentDocument proposaldevelopmentDocument,
                Narrative narrative)

deleteProposalAttachment

void deleteProposalAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument,
                            int lineToDelete)

populatePersonNameForNarrativeUserRights

void populatePersonNameForNarrativeUserRights(ProposalDevelopmentDocument proposaldevelopmentDocument,
                                            Narrative narrative)

replaceAttachment

void replaceAttachment(Narrative narrative)

populateNarrativeRightsForLoggedinUser

void populateNarrativeRightsForLoggedinUser(ProposalDevelopmentDocument proposaldevelopmentDocument)

deleteInstitutionalAttachment

void deleteInstitutionalAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument,
                                 int lineToDelete)

addInstituteAttachment

void addInstituteAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument,
                          Narrative narrative)

deletePerson

void deletePerson(String userId,
                ProposalDevelopmentDocument proposalDevelopmentDocument)

Delete a person from all of the narratives. When a user is removed from the Permissions page, that user must also be removed from the narratives.

Parameters:

username - the name of the user

proposalDevelopmentDocument - the Proposal Development Document

readjustRights

void readjustRights(String userId,
                  ProposalDevelopmentDocument proposalDevelopmentDocument,
                  List<String> roleNames)

Re-adjust the narrative rights for a user. If the user has lost some permissions regarding narratives, his/her narrative rights may need to be down-graded.

Parameters:

username - the name of the user

proposalDevelopmentDocument - the Proposal Development Document

roleNames - the roles the user is in

addPerson

void addPerson(String userId,
             ProposalDevelopmentDocument proposalDevelopmentDocument,
             String roleName)

Add a person to all of the Narratives in a proposal. When a new user is granted access to a proposal via the Permissions page, that user must be added to all of the narratives with the appropriate default narrative right based upon their permissions.

Parameters:

username - the name of the user

proposalDevelopmentDocument - the Proposal Development Document

roleName - the initial proposal role of the user

setNarrativeTimeStampUser

void setNarrativeTimeStampUser(List<Narrative> narratives)

This method set up timestamp and upload user for narrative & internal attachments.

Parameters:

narratives -