1 /*
2 * The Kuali Financial System, a comprehensive financial management system for higher education.
3 *
4 * Copyright 2005-2014 The Kuali Foundation
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
15 *
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 package org.kuali.kfs.sys.service;
20
21 import java.util.List;
22
23 /**
24 * This interface defines methods that an AccountingLine service implementation must provide.
25 */
26 public interface AccountingLineService {
27 /**
28 * Retrieves a list of accounting lines for a given group (i.e. Target/Source) given the associated document id.
29 *
30 * @param clazz
31 * @param documentHeaderId
32 * @return A list of AccountingLines... to be casted to the appropriate class.
33 * @throws Exception
34 */
35 public List getByDocumentHeaderId(Class clazz, String documentHeaderId);
36
37 /**
38 * Retrieves a list of accounting lines for a document, specified by the given document id, of a given line type
39 * @param clazz the class of the AccountingLine to return
40 * @param documentHeaderId the document number of the document the accounting lines are associated with
41 * @param lineType the line type code of the accounting lines to retrieve
42 * @return a List of matching accounting lines
43 */
44 public List getByDocumentHeaderIdAndLineType(Class clazz, String documentHeaderId, String lineType);
45
46 }