001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.module.ld.service;
017    
018    import java.util.Map;
019    
020    import org.kuali.kfs.gl.businessobject.Transaction;
021    
022    /**
023     * This class...
024     */
025    public interface LaborTransactionDescriptionService {
026    
027        /**
028         * get the transaction description from the description map for the given transaction, where the description map can be defined
029         * and injected.
030         * 
031         * @param transaction the given transaction
032         * @return the transaction description indexed by the document type of the given transaction
033         */
034        public String getTransactionDescription(Transaction transaction);
035    
036        /**
037         * get the transaction description from the description map with the given key
038         * 
039         * @param descriptionKey the given key that indexes a description in the description map, where the description map can be
040         *        defined and injected.
041         * @return the transaction description indexed by the given key
042         */
043        public String getTransactionDescription(String descriptionKey);
044    }