Package org.kuali.coeus.common.api.sponsor.hierarchy

Interface SponsorHierarchyService

public interface SponsorHierarchyService

Field Summary

Fields

Modifier and Type	Field	Description
static String	SPONSOR_HIERARCHY_KCOI_PHS
static String	SPONSOR_HIERARCHY_NIH_MULT_PI

Method Summary

Modifier and Type	Method	Description
boolean	isSponsorInHierarchy(String sponsorCode, String hierarchyName)	Checks if a given sponsor is in the hierarchy for any level.
boolean	isSponsorInHierarchy(String sponsorCode, String hierarchyName, int level, String levelName)	Checks if a given sponsor is in the hierarchy for a specific level.
boolean	isSponsorKcoiPhs(String sponsorCode)	Check if a given sponsor is in the KCOI PHS hierarchy for any level.
boolean	isSponsorNihMultiplePi(String sponsorCode)	Checks if a given sponsor is in the NIH Multiple PI hierarchy for any level.
boolean	isSponsorNihOsc(String sponsorCode)	Deprecated. This is probably not used anymore.

Field Detail

SPONSOR_HIERARCHY_NIH_MULT_PI

static final String SPONSOR_HIERARCHY_NIH_MULT_PI

See Also:

Constant Field Values

SPONSOR_HIERARCHY_KCOI_PHS

static final String SPONSOR_HIERARCHY_KCOI_PHS

See Also:

Constant Field Values

Method Detail

isSponsorInHierarchy

boolean isSponsorInHierarchy(String sponsorCode,
                             String hierarchyName,
                             int level,
                             String levelName)

Checks if a given sponsor is in the hierarchy for a specific level.

Parameters:

sponsorCode - the sponsor code. Cannot be blank.

hierarchyName - the hierarchy name. Cannot be blank.

level - the hierarchy level. Must be between 1 and 10 inclusive.

levelName - the level name. Cannot be blank.

Returns:

returns true if the sponsor is in the hierarchy

Throws:

IllegalArgumentException - if the sponsorCode, hierarchyName, or levelName is blank or if level is not between 1 and 10 inclusive

isSponsorInHierarchy

boolean isSponsorInHierarchy(String sponsorCode,
                             String hierarchyName)

Checks if a given sponsor is in the hierarchy for any level.

Parameters:

sponsorCode - the sponsor code. Cannot be blank.

hierarchyName - the hierarchy name. Cannot be blank.

Returns:

returns true if the sponsor is in the hierarchy

Throws:

IllegalArgumentException - if the sponsorCode, hierarchyName is blank

isSponsorNihMultiplePi

boolean isSponsorNihMultiplePi(String sponsorCode)

Checks if a given sponsor is in the NIH Multiple PI hierarchy for any level.

Parameters:

sponsorCode - the sponsor code. Cannot be blank.

Returns:

returns true if the sponsor code is a "NIH Multiple PI" type

Throws:

IllegalArgumentException - if the sponsorCode is blank

isSponsorNihOsc

@Deprecated
boolean isSponsorNihOsc(String sponsorCode)

Deprecated.

This is probably not used anymore. To check if a sponsor is NIH call isSponsorNihMultiplePi(String)

Checks if the sponsor code is a "NIH Other Significant Contributor" type.

Parameters:

sponsorCode - the sponsor code. Cannot be blank.

Returns:

returns true if the sponsor code is a "NIH Other Significant Contributor" type

Throws:

IllegalArgumentException - if the sponsorCode is blank

isSponsorKcoiPhs

boolean isSponsorKcoiPhs(String sponsorCode)

Check if a given sponsor is in the KCOI PHS hierarchy for any level.

Parameters:

sponsorCode - the sponsor code. Cannot be blank.

Returns:

returns true if the sponsor code is a "KCOI PHS" type

Throws:

IllegalArgumentException - if the sponsorCode is blank