1 /**
2 * Copyright 2005-2014 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 * Provides basic functions for interacting with the DocumentHeader object in the Rice application framework.
22 *
23 * @author Kuali Rice Team (rice.collab@kuali.org)
24 */
25 public interface DocumentHeaderService {
26
27 /**
28 * This method retrieves a document header using the given documentHeaderId
29 *
30 * @param documentHeaderId - the id of the document to retrieve the document header for
31 * @return the document header associated with the given document header id
32 */
33 public DocumentHeader getDocumentHeaderById(String documentHeaderId);
34
35
36 /**
37 * This method saves a document header object and returns the copy after the save.
38 * Any code using the document header must use the instance returned from this method
39 * for any future operations.
40 *
41 * @param documentHeader - the document header object to save
42 */
43 public DocumentHeader saveDocumentHeader(DocumentHeader documentHeader);
44
45 /**
46 * This method deletes a document header object
47 *
48 * @param documentHeader - the document header to be removed
49 */
50 public void deleteDocumentHeader(DocumentHeader documentHeader);
51
52 }