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.sys.document.web;
017    
018    import java.util.Set;
019    
020    public interface CodeDescriptionFormatter {
021        /**
022         * Given a set of codes, this class will form a format a string that includes their description Example: Codes A, B, C may be
023         * formatted to "A, descA; B, descB; and C; descC"
024         * 
025         * @param values
026         * @param startConjunction a conjunction or phrase to be used for the beginning of the series (e.g. "either", "neither", "any 3
027         *        of" etc.)
028         * @param endConjunction a conjunction to be used for the beginning of the series (e.g. "and", "or", "and/or")
029         * @return
030         */
031        public String getFormattedStringWithDescriptions(Set values, String startConjunction, String endConjunction);
032    }