org.kuali.rice.krad.keyvalues
Interface KeyValuesFinder

All Known Subinterfaces:

UifKeyValuesFinder

All Known Implementing Classes:

AbstractCountryValuesFinderBase, AccountTypeKeyValues, ActionPolicyValuesFinder, ActionPolicyValuesFinder, ActionRequestCodeValuesFinder, ActionTypeValuesFinder, ActionTypeValuesFinder, ActiveInactiveValuesFinder, AddressTypeKeyValues, AdHocActionRequestCodesValuesFinder, AgendaNamespaceValuesFinder, AgendaTypeValuesFinder, AMPMValuesFinder, ApprovedDocumentIndicatorValuesFinder, ApprovePolicyValuesFinder, BookKeyValues, BookTypeKeyValues, BusinessObjectDictionaryEntriesFinder, CampusTypeValuesFinder, CampusValuesFinder, CategoryValuesFinder, CompoundOpCodeValuesFinder, ContextTypeValuesFinder, CountryNotRestrictedValuesFinder, CountryValuesFinder, DelegateRuleValuesFinder, DelegationTypeValuesFinder, DelegationTypeValuesFinder, DelegationTypeValuesFinder, DocumentRouteStatusValuesFinder, DocumentStatusValuesFinder, EnumValuesFinder, FoodKeyValuesFinder, FoodKeyValuesFinder, GroupMemberTypeValuesFinder, IndicatorPersonSearchTypeValuesFinder, IndicatorValuesFinder, IndicatorYNBlankValuesFinder, IndicatorYNNullValuesFinder, IndicatorYNOnlyValuesFinder, InstalledModulesValuesFinder, KewTypeOptionsFinder, KeyValuesBase, KimAttributeValuesFinder, MapValuesFinder, MemberTypeValuesFinder, ModuleValuesFinder, NamePrefixValuesFinder, NamespaceValuesFinder, NameSuffixValuesFinder, OpenCloseValuesFinder, ParameterOperatorValuesFinder, ParameterTypeValuesFinder, PermissionTemplateValuesFinder, PersistableBusinessObjectValuesFinder, PlaceholderKeyValuesFinder, PropositionOpCodeValuesFinder, PropositionParameterTypeValuesFinder, PropositionTypeValuesFinder, RoleNameValuesFinder, RouteNodeLookupLogicValuesFinder, RuleAttributeTypeValuesFinder, RuleMaintenanceActionRequestCodeValuesFinder, RuleTypeValuesFinder, SavedSearchValuesFinder, SimpleTestKeyValueLocations, SimpleTestKeyValues, SimpleTestKeyValues, StateValuesFinder, TravelRequestType, TripTypeValuesFinder, UifKeyValuesFinderBase, ValidTermsForPropositionValuesFinder, ValidTermsValuesFinder

public interface KeyValuesFinder

Defines basic methods value finders

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

void	clearInternalCache() Clears any internal cache that is being maintained by the value finder
String	getKeyLabel(String key) Returns the label for the associated key.
Map<String,String>	getKeyLabelMap() Returns a map with the key as the key of the map and the label as the value.
List<KeyValue>	getKeyValues() Builds a list of key values representations for valid value selections.
List<KeyValue>	getKeyValues(boolean includeActiveOnly) Builds a list of key values representations for valid value selections.

Method Detail

getKeyValues

List<KeyValue> getKeyValues()

Builds a list of key values representations for valid value selections.

Returns:

List of KeyValue objects

getKeyValues

List<KeyValue> getKeyValues(boolean includeActiveOnly)

Builds a list of key values representations for valid value selections.

Parameters:

includeActiveOnly - whether to only include active values in the list

Returns:

List of KeyValue objects.

getKeyLabelMap

Map<String,String> getKeyLabelMap()

Returns a map with the key as the key of the map and the label as the value. Used to render the label instead of the code in the jsp when the field is readonly.

Returns:

getKeyLabel

String getKeyLabel(String key)

Returns the label for the associated key.

Parameters:

key -

Returns:

clearInternalCache

void clearInternalCache()

Clears any internal cache that is being maintained by the value finder