001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.service;
017
018import org.kuali.rice.krad.bo.DocumentHeader;
019
020/**
021 * Provides basic functions for interacting with the DocumentHeader object in the Rice application framework.
022 *
023 * @author Kuali Rice Team (rice.collab@kuali.org)
024 */
025public interface DocumentHeaderService {
026
027    /**
028     * This method retrieves a document header using the given documentHeaderId
029     *
030     * @param documentHeaderId - the id of the document to retrieve the document header for
031     * @return the document header associated with the given document header id
032     */
033    public DocumentHeader getDocumentHeaderById(String documentHeaderId);
034
035
036    /**
037     * This method saves a document header object and returns the copy after the save.
038     * Any code using the document header must use the instance returned from this method
039     * for any future operations.
040     *
041     * @param documentHeader - the document header object to save
042     */
043    public DocumentHeader saveDocumentHeader(DocumentHeader documentHeader);
044
045    /**
046     * This method deletes a document header object
047     *
048     * @param documentHeader - the document header to be removed
049     */
050    public void deleteDocumentHeader(DocumentHeader documentHeader);
051
052}