1 /*
2 * Copyright 2006-2008 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.ole.sys.document.web;
17
18 import java.util.Set;
19
20 public interface CodeDescriptionFormatter {
21 /**
22 * Given a set of codes, this class will form a format a string that includes their description Example: Codes A, B, C may be
23 * formatted to "A, descA; B, descB; and C; descC"
24 *
25 * @param values
26 * @param startConjunction a conjunction or phrase to be used for the beginning of the series (e.g. "either", "neither", "any 3
27 * of" etc.)
28 * @param endConjunction a conjunction to be used for the beginning of the series (e.g. "and", "or", "and/or")
29 * @return
30 */
31 public String getFormattedStringWithDescriptions(Set values, String startConjunction, String endConjunction);
32 }