org.kuali.kra.service

Interface SponsorService

All Known Implementing Classes:

SponsorServiceImpl

public interface SponsorService

Method Summary

Methods

Modifier and Type	Method and Description
void	changeSponsorSortOrder(String hierarchyName, Integer levelToChange, Boolean moveDown, String[] levels) Change the sponsor sort order at the specified level.
void	clearCurrentActions() Remove all previously queued actions
void	copySponsorHierarchy(SponsorHierarchyForm sponsorHierarchyForm) This method save the new hierarchy that is coming from copy action
void	deleteSponsor(String hierarchyName, String sponsorCode, String[] levels) Delete the sponsor identified by hierarchy name and levels.
void	deleteSponsorHierarchy(SponsorHierarchyForm sponsorHierarchyForm) This method is to delete the selected hierarchy
void	executeActions() Execute all actions queued by insertSponsor, deleteSponsor, updateGroupName or changeSponsorSortOrder
Sponsor	getSponsor(String sponsorCode) Get the sponsor for the given sponsor code
String	getSponsorCodes(String hierarchyName, String depth, String groups) This method get the sponsor codes for the groups that is selected for deletion.
String	getSponsorName(String sponsorCode) This method returns the sponsor name for a given sponsor code.
String	getSubSponsorHierarchiesForTreeView(String hierarchyName, String depth, String groups) This method is to retrieve next level nodes.
String	getTopSponsorHierarchy() This method to get the list of unique sponsorhierarchy name.
Collection	getTopSponsorHierarchyList() This method the sponsor hierarchy name for drop downs
List<String>	getUniqueGroupingNames(String hierarchyName, Integer level) Get the list of groupings at the specified level.
void	insertSponsor(String hierarchyName, String[] sponsorCodes, String[] levels, Integer[] sortIds) Insert new sponsors into the hierarchy defined by hierarchy name and levels.
boolean	isSponsorNihMultiplePi(Sponsorable sponsorable) This method returns true if a Sponsorable's sponsor is of the "NIH Multiple PI" type.
boolean	isSponsorNihOsc(Sponsorable sponsorable) This method returns true if a Sponsorable's sponsor is of the "NIH Other Significant Contributor" type.
String	loadToSponsorHierachyMt(String hierarchyName) This method to load data for sponsor hierarchy maint
void	updateGroupName(String hierarchyName, Integer levelToChange, String oldGroupName, String newGroupName, String[] levels) Change the hierarchy group name at the specified level.
void	updateSponsorCodes(String sponsorCodes) This method is to put the sponsorcodes for the hierarchy in session.
boolean	validateSponsor(Sponsor sponsor) This method returns true if the passed in Sponsor is valid, returns false if it is not.

Method Detail

getSponsorName

String getSponsorName(String sponsorCode)

This method returns the sponsor name for a given sponsor code.

Parameters:

sponsorCode - identifier for the sponsor

Returns:

The name of the sponsor identified by this code.

getSponsor

Sponsor getSponsor(String sponsorCode)

Get the sponsor for the given sponsor code

Parameters:

sponsorCode -

Returns:

getTopSponsorHierarchy

String getTopSponsorHierarchy()

This method to get the list of unique sponsorhierarchy name.

Returns:

getSubSponsorHierarchiesForTreeView

String getSubSponsorHierarchiesForTreeView(String hierarchyName,
                                         String depth,
                                         String groups)

This method is to retrieve next level nodes. It is called by ajax.

Parameters:

node -

Returns:

copySponsorHierarchy

void copySponsorHierarchy(SponsorHierarchyForm sponsorHierarchyForm)

This method save the new hierarchy that is coming from copy action

Parameters:

sponsorHierarchyForm -

deleteSponsorHierarchy

void deleteSponsorHierarchy(SponsorHierarchyForm sponsorHierarchyForm)

This method is to delete the selected hierarchy

Parameters:

sponsorHierarchyForm -

getTopSponsorHierarchyList

Collection getTopSponsorHierarchyList()

This method the sponsor hierarchy name for drop downs

Returns:

loadToSponsorHierachyMt

String loadToSponsorHierachyMt(String hierarchyName)

This method to load data for sponsor hierarchy maint

Parameters:

hierarchyName -

Returns:

getSponsorCodes

String getSponsorCodes(String hierarchyName,
                     String depth,
                     String groups)

This method get the sponsor codes for the groups that is selected for deletion.

Parameters:

hierarchyName -

depth -

groups -

Returns:

isSponsorNihMultiplePi

boolean isSponsorNihMultiplePi(Sponsorable sponsorable)

This method returns true if a Sponsorable's sponsor is of the "NIH Multiple PI" type.

Parameters:

sponsorable -

Returns:

isSponsorNihOsc

boolean isSponsorNihOsc(Sponsorable sponsorable)

This method returns true if a Sponsorable's sponsor is of the "NIH Other Significant Contributor" type.

Parameters:

sponsorable -

Returns:

updateSponsorCodes

void updateSponsorCodes(String sponsorCodes)

This method is to put the sponsorcodes for the hierarchy in session. so it can be checked to be excluded for search.

Parameters:

sponsorCodes -

insertSponsor

void insertSponsor(String hierarchyName,
                 String[] sponsorCodes,
                 String[] levels,
                 Integer[] sortIds)

Insert new sponsors into the hierarchy defined by hierarchy name and levels. Will only queue action as this will be used primarily by Ajax. To execute the action call executeActions.

Parameters:

hierarchyName -

sponsorCodes -

levels -

sortIds -

deleteSponsor

void deleteSponsor(String hierarchyName,
                 String sponsorCode,
                 String[] levels)

Delete the sponsor identified by hierarchy name and levels. Will only queue action as this will be used primarily by Ajax. To execute the action call executeActions

Parameters:

hierarchyName -

sponsorCode - can be null to delete all sponsors defined by levels

levels -

updateGroupName

void updateGroupName(String hierarchyName,
                   Integer levelToChange,
                   String oldGroupName,
                   String newGroupName,
                   String[] levels)

Change the hierarchy group name at the specified level. Will only queue action as this will be used primarily by Ajax. To execute the action call executeActions.

Parameters:

hierarchyName -

levelToChange -

oldGroupName -

newGroupName -

levels -

changeSponsorSortOrder

void changeSponsorSortOrder(String hierarchyName,
                          Integer levelToChange,
                          Boolean moveDown,
                          String[] levels)

Change the sponsor sort order at the specified level. Will only queue action as this will be used primarily by Ajax. To execute the action call executeActions.

Parameters:

hierarchyName -

levelToChange -

moveDown -

levels -

executeActions

void executeActions()

Execute all actions queued by insertSponsor, deleteSponsor, updateGroupName or changeSponsorSortOrder

clearCurrentActions

void clearCurrentActions()

Remove all previously queued actions

getUniqueGroupingNames

List<String> getUniqueGroupingNames(String hierarchyName,
                                  Integer level)

Get the list of groupings at the specified level.

Parameters:

hierarchyName -

level -

Returns:

validateSponsor

boolean validateSponsor(Sponsor sponsor)

This method returns true if the passed in Sponsor is valid, returns false if it is not.

Parameters:

sponsor -

Returns: