org.kuali.ole.sys.document.web

Interface CodeDescriptionFormatter

All Known Implementing Classes:

CodeDescriptionFormatterBase, DocumentationLocationCodeDescriptionFormatter, ObjectCodeDescriptionFormatter, ObjectLevelCodeDescriptionFormatter, ObjectTypeCodeDescriptionFormatter, SubFundGroupCodeDescriptionFormatter

public interface CodeDescriptionFormatter

Method Summary

Methods

Modifier and Type	Method and Description
String	getFormattedStringWithDescriptions(Set values, String startConjunction, String endConjunction) Given a set of codes, this class will form a format a string that includes their description Example: Codes A, B, C may be formatted to "A, descA; B, descB; and C; descC"

Method Detail

getFormattedStringWithDescriptions

String getFormattedStringWithDescriptions(Set values,
                                        String startConjunction,
                                        String endConjunction)

Given a set of codes, this class will form a format a string that includes their description Example: Codes A, B, C may be formatted to "A, descA; B, descB; and C; descC"

Parameters:

values -

startConjunction - a conjunction or phrase to be used for the beginning of the series (e.g. "either", "neither", "any 3 of" etc.)

endConjunction - a conjunction to be used for the beginning of the series (e.g. "and", "or", "and/or")

Returns: