01: /*
02: * Copyright 2005-2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16: package org.kuali.module.chart.service;
17:
18: import java.util.List;
19: import java.util.Map;
20:
21: import org.kuali.core.bo.user.UniversalUser;
22: import org.kuali.module.chart.bo.Chart;
23:
24: /**
25: * This interface defines methods that a Chart Service must provide
26: */
27: public interface ChartService {
28: /**
29: * Retrieves a chart object by its primary key - the chart code.
30: *
31: * @param chartOfAccountsCode
32: * @return
33: */
34: public Chart getByPrimaryId(String chartOfAccountsCode);
35:
36: /**
37: *
38: * This method returns the university chart
39: * @return
40: */
41: public Chart getUniversityChart();
42:
43: /**
44: * Retrieves all of the charts in the system and returns them in a List.
45: *
46: * @return A List of chart objects.
47: */
48: public List getAllChartCodes();
49:
50: /**
51: * Retrieves a map of reportsTo relationships (e.g. A reports to B, B reports to B, C reports to A)
52: *
53: * @return
54: */
55: public Map<String, String> getReportsToHierarchy();
56:
57: /**
58: * Retrieves a list of chart objects that the User is responsible for
59: *
60: * @param kualiUser
61: * @return
62: */
63: public List getChartsThatUserIsResponsibleFor(
64: UniversalUser kualiUser);
65:
66: }
|