1 /**
2 * Copyright 2005-2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
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.rice.krad.service;
17
18 import org.kuali.rice.krad.bo.DocumentHeader;
19
20 /**
21 * This is an interface to allow for Rice client applications to override the
22 * DocumentHeader class being used. Originally written to facilitate the Kuali
23 * Financial System custom document header which included a 'total amount'
24 * field.
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 *
28 */
29 public interface DocumentHeaderService {
30
31 /**
32 * This method returns the class to use to instantiate document header objects
33 *
34 * @return the class to be used for new document header objects
35 */
36 public Class<? extends DocumentHeader> getDocumentHeaderBaseClass();
37
38 /**
39 * This method retrieves a document header using the given documentHeaderId
40 *
41 * @param documentHeaderId - the id of the document to retrieve the document header for
42 * @return the document header associated with the given document header id
43 */
44 public DocumentHeader getDocumentHeaderById(String documentHeaderId);
45
46
47 /**
48 * This method saves a document header object
49 *
50 * @param documentHeader - the document header object to save
51 */
52 public void saveDocumentHeader(DocumentHeader documentHeader);
53
54 /**
55 * This method deletes a document header object
56 *
57 * @param documentHeader - the document header to be removed
58 */
59 public void deleteDocumentHeader(DocumentHeader documentHeader);
60
61 }