org.kuali.rice.krad.keyvalues
Class KeyValuesBase

java.lang.Object
  org.kuali.rice.krad.keyvalues.KeyValuesBase

All Implemented Interfaces:

Serializable, KeyValuesFinder

Direct Known Subclasses:

AbstractCountryValuesFinderBase, AccountTypeKeyValues, ActionPolicyValuesFinder, ActionPolicyValuesFinder, ActionRequestCodeValuesFinder, ActionTypeValuesFinder, ActiveInactiveValuesFinder, AddressTypeKeyValues, AMPMValuesFinder, ApprovedDocumentIndicatorValuesFinder, ApprovePolicyValuesFinder, BookKeyValues, BookTypeKeyValues, BusinessObjectDictionaryEntriesFinder, CampusTypeValuesFinder, CampusValuesFinder, CompoundOpCodeValuesFinder, DelegateRuleValuesFinder, DelegationTypeValuesFinder, DelegationTypeValuesFinder, DelegationTypeValuesFinder, DocumentRouteStatusValuesFinder, DocumentStatusValuesFinder, EnumValuesFinder, GroupMemberTypeValuesFinder, IndicatorPersonSearchTypeValuesFinder, IndicatorValuesFinder, IndicatorYNNullValuesFinder, IndicatorYNOnlyValuesFinder, InstalledModulesValuesFinder, KimAttributeValuesFinder, MemberTypeValuesFinder, MileageRateKeyValues, ModuleValuesFinder, NamePrefixValuesFinder, NamespaceValuesFinder, NameSuffixValuesFinder, OpenCloseValuesFinder, ParameterOperatorValuesFinder, ParameterTypeValuesFinder, PermissionTemplateValuesFinder, PersistableBusinessObjectValuesFinder, PlaceholderKeyValuesFinder, PropositionParameterTypeValuesFinder, RoleNameValuesFinder, RuleAttributeTypeValuesFinder, SavedSearchValuesFinder, SimpleTestKeyValues, SimpleTestKeyValues, StateValuesFinder, TravelDestinationKeyValues, TravelRequestType, UifKeyValuesFinderBase

public abstract class KeyValuesBase
extends Object
implements KeyValuesFinder, Serializable

Abstract base implementation of KeyValuesFinder

Author:

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

See Also:

Serialized Form

Constructor Summary

KeyValuesBase()

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(boolean includeActiveOnly) Builds a list of key values representations for valid value selections.
Collection<String>	getOptionLabels()
Collection<String>	getOptionValues()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.kuali.rice.krad.keyvalues.KeyValuesFinder

getKeyValues

Constructor Detail

KeyValuesBase

public KeyValuesBase()

Method Detail

getOptionLabels

public Collection<String> getOptionLabels()

getOptionValues

public Collection<String> getOptionValues()

getKeyLabelMap

public Map<String,String> getKeyLabelMap()

Description copied from interface: KeyValuesFinder

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.

Specified by:

getKeyLabelMap in interface KeyValuesFinder

Returns:

See Also:

KeyValuesFinder.getKeyLabelMap()

getKeyLabel

public String getKeyLabel(String key)

Description copied from interface: KeyValuesFinder

Returns the label for the associated key.

Specified by:

getKeyLabel in interface KeyValuesFinder

Returns:

See Also:

KeyValuesFinder.getKeyLabel(String)

getKeyValues

public List<KeyValue> getKeyValues(boolean includeActiveOnly)

Description copied from interface: KeyValuesFinder

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

Specified by:

getKeyValues in interface KeyValuesFinder

Parameters:

includeActiveOnly - whether to only include active values in the list

Returns:

List of KeyValue objects.

See Also:

KeyValuesFinder.getKeyValues(boolean)

clearInternalCache

public void clearInternalCache()

Description copied from interface: KeyValuesFinder

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

Specified by:

clearInternalCache in interface KeyValuesFinder

See Also:

KeyValuesFinder.clearInternalCache()