org.kuali.kra.proposaldevelopment.service.impl

Class NarrativeServiceImpl

java.lang.Object

org.kuali.kra.proposaldevelopment.service.impl.NarrativeServiceImpl

All Implemented Interfaces:

NarrativeService

public class NarrativeServiceImpl
extends Object
implements NarrativeService

This class is primarily to add/delete proposal/institute attachments.

Constructor Summary

Constructors

Constructor and Description
NarrativeServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addInstituteAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument, Narrative narrative) Method to add a new institute attachment to institute attachment list
void	addNarrative(ProposalDevelopmentDocument proposaldevelopmentDocument, Narrative narrative) Method to add a new narrative to narratives list
void	addPerson(String userName, ProposalDevelopmentDocument proposalDevelopmentDocument, String roleName) Add a person to all of the Narratives in a proposal.
protected void	deleteAttachment(List<Narrative> narratives, int lineToDelete)
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)
AttachmentDao	getAttachmentDao()
org.kuali.rice.krad.service.BusinessObjectService	getBusinessObjectService() Gets the businessObjectService attribute.
org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService() Gets the dateTimeService attribute.
protected KraAuthorizationService	getKraAuthorizationService() This is a helper method for retrieving KraAuthorizationService
NarrativeAuthZService	getNarrativeAuthZService() Gets the narrativeAuthZService attribute.
protected Integer	getNextModuleNumber(ProposalDevelopmentDocument proposaldevelopmentDocument)
protected Integer	getNextModuleSequenceNumber(ProposalDevelopmentDocument proposaldevelopmentDocument)
protected List<KcPerson>	getPersons(ProposalDevelopmentDocument proposalDevelopmentDocument) Get the persons who have permissions relating to the proposal.
protected org.kuali.rice.kim.api.identity.PersonService	getPersonService()
ProposalPersonService	getProposalPersonService() Gets the proposalPersonService attribute.
protected boolean	isPersonInList(KcPerson person, List<KcPerson> persons) Is the person in the list of persons?
protected boolean	isPersonInNarrativeRights(KcPerson person, List<NarrativeUserRights> narrativeUserRights) Is this person in the list of narrative user rights?
void	populateNarrativeRightsForLoggedinUser(ProposalDevelopmentDocument proposaldevelopmentDocument)
protected void	populateNarrativeUserRights(ProposalDevelopmentDocument proposalDevelopmentDocument, Narrative narrative) This method used to add narrative user rights to a narrative.
void	populatePersonNameForNarrativeUserRights(ProposalDevelopmentDocument proposaldevelopmentDocument, Narrative narrative) Method to populate personname for all user who have narrative rights
void	readjustRights(String userId, ProposalDevelopmentDocument proposalDevelopmentDocument, List<String> roleNames) Re-adjust the narrative rights for a user.
void	replaceAttachment(Narrative narrative)
void	setAttachmentDao(AttachmentDao attachmentDao)
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService) Sets the businessObjectService attribute value.
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
void	setKcPersonService(KcPersonService kcPersonService) Sets the KC Person Service.
void	setNarrativeAuthZService(NarrativeAuthZService narrativeAuthZService) Sets the narrativeAuthZService attribute value.
void	setNarrativeTimeStampUser(List<Narrative> narratives) This method set up timestamp and upload user for narrative & internal attachments.
void	setPersonService(org.kuali.rice.kim.api.identity.PersonService personService)
void	setProposalPersonService(ProposalPersonService proposalPersonService) Sets the proposalPersonService attribute value.
void	setSystemAuthorizationService(SystemAuthorizationService systemAuthorizationService)
protected void	updateUserTimestamp(KraPersistableBusinessObjectBase bo) Update the User and Timestamp for the business object.

Methods inherited from class java.lang.Object

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

Constructor Detail

NarrativeServiceImpl

public NarrativeServiceImpl()

Method Detail

addNarrative

public void addNarrative(ProposalDevelopmentDocument proposaldevelopmentDocument,
                Narrative narrative)

Method to add a new narrative to narratives list

Specified by:

addNarrative in interface NarrativeService

Parameters:

narrative -

getNextModuleNumber

protected Integer getNextModuleNumber(ProposalDevelopmentDocument proposaldevelopmentDocument)

getNextModuleSequenceNumber

protected Integer getNextModuleSequenceNumber(ProposalDevelopmentDocument proposaldevelopmentDocument)

populateNarrativeUserRights

protected void populateNarrativeUserRights(ProposalDevelopmentDocument proposalDevelopmentDocument,
                               Narrative narrative)

This method used to add narrative user rights to a narrative. Each person that is added to a Proposal (see Permission's page) must also be in a narrative's list of users. For each user that isn't currently associated with the narrative, we will add the user with a default narrative right based upon their permissions.

Parameters:

proposalDevelopmentDocument - the Proposal Development Document

narrative - the narrative to add the users to

isPersonInNarrativeRights

protected boolean isPersonInNarrativeRights(KcPerson person,
                                List<NarrativeUserRights> narrativeUserRights)

Is this person in the list of narrative user rights?

Parameters:

person - the person to look for

narrativeUserRights - the list of narrative user rights

Returns:

true if the person is in the list; otherwise false

getPersons

protected List<KcPerson> getPersons(ProposalDevelopmentDocument proposalDevelopmentDocument)

Get the persons who have permissions relating to the proposal.

Parameters:

proposalDevelopmentDocument - the Proposal Development Document

Returns:

the list of persons (see Permission's page)

isPersonInList

protected boolean isPersonInList(KcPerson person,
                     List<KcPerson> persons)

Is the person in the list of persons?

Parameters:

person - the person to look for

persons - the list of persons

Returns:

true if the person is in the list; otherwise false

deleteProposalAttachment

public void deleteProposalAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument,
                            int lineToDelete)

Specified by:

deleteProposalAttachment in interface NarrativeService

deleteInstitutionalAttachment

public void deleteInstitutionalAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument,
                                 int lineToDelete)

Specified by:

deleteInstitutionalAttachment in interface NarrativeService

deleteAttachment

protected void deleteAttachment(List<Narrative> narratives,
                    int lineToDelete)

addInstituteAttachment

public void addInstituteAttachment(ProposalDevelopmentDocument proposaldevelopmentDocument,
                          Narrative narrative)

Method to add a new institute attachment to institute attachment list

Specified by:

addInstituteAttachment in interface NarrativeService

Parameters:

narrative -

populatePersonNameForNarrativeUserRights

public void populatePersonNameForNarrativeUserRights(ProposalDevelopmentDocument proposaldevelopmentDocument,
                                            Narrative narrative)

Method to populate personname for all user who have narrative rights

Specified by:

populatePersonNameForNarrativeUserRights in interface NarrativeService

See Also:

NarrativeService.populatePersonNameForNarrativeUserRights(org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument, org.kuali.kra.proposaldevelopment.bo.Narrative)

replaceAttachment

public void replaceAttachment(Narrative narrative)

Specified by:

replaceAttachment in interface NarrativeService

populateNarrativeRightsForLoggedinUser

public void populateNarrativeRightsForLoggedinUser(ProposalDevelopmentDocument proposaldevelopmentDocument)

Specified by:

populateNarrativeRightsForLoggedinUser in interface NarrativeService

updateUserTimestamp

protected void updateUserTimestamp(KraPersistableBusinessObjectBase bo)

Update the User and Timestamp for the business object.

Parameters:

bo - the business object

getNarrativeAuthZService

public NarrativeAuthZService getNarrativeAuthZService()

Gets the narrativeAuthZService attribute.

Returns:

Returns the narrativeAuthZService.

setNarrativeAuthZService

public void setNarrativeAuthZService(NarrativeAuthZService narrativeAuthZService)

Sets the narrativeAuthZService attribute value.

Parameters:

narrativeAuthZService - The narrativeAuthZService to set.

getProposalPersonService

public ProposalPersonService getProposalPersonService()

Gets the proposalPersonService attribute.

Returns:

Returns the proposalPersonService.

setProposalPersonService

public void setProposalPersonService(ProposalPersonService proposalPersonService)

Sets the proposalPersonService attribute value.

Parameters:

proposalPersonService - The proposalPersonService to set.

getBusinessObjectService

public org.kuali.rice.krad.service.BusinessObjectService getBusinessObjectService()

Gets the businessObjectService attribute.

Returns:

Returns the businessObjectService.

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

Sets the businessObjectService attribute value.

Parameters:

businessObjectService - The businessObjectService to set.

getDateTimeService

public org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

Gets the dateTimeService attribute.

Returns:

Returns the dateTimeService.

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Sets the dateTimeService attribute value.

Parameters:

dateTimeService - The dateTimeService to set.

deletePerson

public void deletePerson(String userId,
                ProposalDevelopmentDocument proposalDevelopmentDocument)

Description copied from interface: NarrativeService

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.

Specified by:

deletePerson in interface NarrativeService

proposalDevelopmentDocument - the Proposal Development Document

See Also:

NarrativeService.deletePerson(java.lang.String, org.kuali.kra.proposaldevelopment.document.ProposalDevelopmentDocument)

readjustRights

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

Description copied from interface: NarrativeService

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.

Specified by:

readjustRights in interface NarrativeService

proposalDevelopmentDocument - the Proposal Development Document

roleNames - the roles the user is in

addPerson

public void addPerson(String userName,
             ProposalDevelopmentDocument proposalDevelopmentDocument,
             String roleName)

Description copied from interface: NarrativeService

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.

Specified by:

addPerson in interface NarrativeService

proposalDevelopmentDocument - the Proposal Development Document

roleName - the initial proposal role of the user

setKcPersonService

public void setKcPersonService(KcPersonService kcPersonService)

Sets the KC Person Service.

Parameters:

kcPersonService - the kc person service

getAttachmentDao

public AttachmentDao getAttachmentDao()

setAttachmentDao

public void setAttachmentDao(AttachmentDao attachmentDao)

setNarrativeTimeStampUser

public void setNarrativeTimeStampUser(List<Narrative> narratives)

Description copied from interface: NarrativeService

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

Specified by:

setNarrativeTimeStampUser in interface NarrativeService

See Also:

NarrativeService.setNarrativeTimeStampUser(java.util.List)

getKraAuthorizationService

protected KraAuthorizationService getKraAuthorizationService()

This is a helper method for retrieving KraAuthorizationService

Returns:

setSystemAuthorizationService

public void setSystemAuthorizationService(SystemAuthorizationService systemAuthorizationService)

getPersonService

protected org.kuali.rice.kim.api.identity.PersonService getPersonService()

setPersonService

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