org.kuali.kfs.coa.service
Interface ChartService

All Known Implementing Classes:

ChartServiceImpl

public interface ChartService

This interface defines methods that a Chart Service must provide

Method Summary

List<String>	getAllChartCodes() Retrieves all of the charts in the system and returns them in a List.
Chart	getByPrimaryId(String chartOfAccountsCode) Retrieves a chart object by its primary key - the chart code.
org.kuali.rice.kim.bo.Person	getChartManager(String chartOfAccountsCode) Returns the chart manager form KIM for the given chart code
List	getChartsThatUserIsResponsibleFor(org.kuali.rice.kim.bo.Person kualiUser) Retrieves a list of chart objects that the User is responsible for
Map<String,String>	getReportsToHierarchy() Retrieves a map of reportsTo relationships (e.g.
Chart	getUniversityChart() This method returns the university chart
boolean	isParentChart(String potentialChildChartCode, String potentialParentChartCode) This method traverses the hierarchy to see if the potentialChildChartCode reports to the potentialParentChartCode

Method Detail

getByPrimaryId

Chart getByPrimaryId(String chartOfAccountsCode)

Retrieves a chart object by its primary key - the chart code.

Parameters:

chartOfAccountsCode -

Returns:

getUniversityChart

Chart getUniversityChart()

This method returns the university chart

Returns:

getAllChartCodes

List<String> getAllChartCodes()

Retrieves all of the charts in the system and returns them in a List.

Returns:

A List of chart codes.

getReportsToHierarchy

Map<String,String> getReportsToHierarchy()

Retrieves a map of reportsTo relationships (e.g. A reports to B, B reports to B, C reports to A)

Returns:

getChartsThatUserIsResponsibleFor

List getChartsThatUserIsResponsibleFor(org.kuali.rice.kim.bo.Person kualiUser)

Retrieves a list of chart objects that the User is responsible for

Parameters:

kualiUser -

Returns:

getChartManager

org.kuali.rice.kim.bo.Person getChartManager(String chartOfAccountsCode)

Returns the chart manager form KIM for the given chart code

Parameters:

chartOfAccountsCode - chart code to get manager for

Returns:

chart manager Person

isParentChart

boolean isParentChart(String potentialChildChartCode,
                      String potentialParentChartCode)

This method traverses the hierarchy to see if the potentialChildChartCode reports to the potentialParentChartCode

Parameters:

potentialChildChartCode -

potentialParentChartCode -

Returns:

boolean indicating whether the first parameter reports to the second