org.opencms.workplace.list
Interface I_CmsSearchMethod

All Superinterfaces:

I_CmsHtmlIconButton, I_CmsListAction

All Known Implementing Classes:

CmsListSearchAction

public interface I_CmsSearchMethod
extends I_CmsListAction

Defines a search action, that is a list action with an additional method for filtering.

Since:

6.0.0

Version:

$Revision: 1.5 $

Author:

Michael Moossen

Method Summary

List	filter(List items, String filter) Returns a sublist of the given items, that match the filter string.

Methods inherited from interface org.opencms.workplace.list.I_CmsListAction

getConfirmationMessage, getListId, setConfirmationMessage, setListId

Methods inherited from interface org.opencms.workplace.tools.I_CmsHtmlIconButton

buttonHtml, getHelpText, getIconPath, getId, getName, isEnabled, isVisible, setEnabled, setHelpText, setIconPath, setName, setVisible

Method Detail

filter

List filter(List items,
            String filter)

Returns a sublist of the given items, that match the filter string.

Parameters:

items - the items to filter

filter - the filter string

Returns:

the filtered sublist