com.webmethods.caf.faces.data
Interface IFilterableSelectItemGroupProvider

All Superinterfaces:
ISelectItemGroupProvider, ISelectItemProvider
All Known Implementing Classes:
CharacterEncodingSelectItemGroupProvider, DefaultSelectItemGroupProvider, DirectoryServicesSelectItemGroupProvider, LocaleSelectItemGroupProvider, PrincipalAttributeValueSourceSelectItemGroupProvider

public interface IFilterableSelectItemGroupProvider
extends ISelectItemGroupProvider

Allows a group of select-items to be filterable.


Method Summary
 ISelectItemProvider findSelectItemContentProvider(Object value)
          Finds the first item in the group with the exact specified value.
 String getFilter()
          Filter expression.
 boolean isFilterable()
          True if this provider truely is filterable.
 void setFilter(String filter)
          Filter expression.
 
Methods inherited from interface com.webmethods.caf.faces.data.ISelectItemGroupProvider
getSelectItemContentProviders
 
Methods inherited from interface com.webmethods.caf.faces.data.ISelectItemProvider
getDescription, getIcon, getLabel, getStyle, getValue, isDisabled, isEscape
 

Method Detail

isFilterable

boolean isFilterable()
True if this provider truely is filterable.


getFilter

String getFilter()
Filter expression. The collection returned by the ISelectItemGroupProvider.getSelectItemContentProviders() method should reflect the filter settings. Null or empty ("") signals expose the default collection.


setFilter

void setFilter(String filter)
Filter expression. The collection returned by the ISelectItemGroupProvider.getSelectItemContentProviders() method should reflect the filter settings. Null or empty ("") signals expose the default collection.


findSelectItemContentProvider

ISelectItemProvider findSelectItemContentProvider(Object value)
Finds the first item in the group with the exact specified value. Searches the entire collection, regardless of the filter expression. Returns null if no item is found.