com.arsdigita.bebop.event
Interface SearchAndSelectModel


public interface SearchAndSelectModel

Listener interface for the SeachAndSelect Bebop widget. SearchAndSelect requires knowledge about the data it is searching over (to determine the display method and to actually execute the query).

Since:
4.5
Version:
$Id: //core-platform/dev/src/com/arsdigita/bebop/event/SearchAndSelectModel.java#8 $
Author:
Patrick McNeill

Field Summary
static String versionId
           
 
Method Summary
 String getID(int i)
          Get the "i"th ID (0 based indexing)
 String getLabel(int i)
          Get the "i"th label (0 based indexing)
 String getQuery()
          Retrieve the query that was last used.
 int resultsCount()
          Return the number of items that are currently selected by the query string.
 void setQuery(String query)
          Specify the user's search and restrict the result set to those queries that match.
 

Field Detail

versionId

public static final String versionId
See Also:
Constant Field Values
Method Detail

setQuery

public void setQuery(String query)
Specify the user's search and restrict the result set to those queries that match. An empty string should return all results.

Parameters:
query - the user's search string, space or comma delimited words

getQuery

public String getQuery()
Retrieve the query that was last used.

Returns:
the query string

resultsCount

public int resultsCount()
Return the number of items that are currently selected by the query string. If the query string is empty, this should return the number of items in the dataset.

Returns:
the number of currently selected items

getLabel

public String getLabel(int i)
Get the "i"th label (0 based indexing)

Parameters:
i - the label number to retrieve
Returns:
the ith label

getID

public String getID(int i)
Get the "i"th ID (0 based indexing)

Parameters:
i - the ID number to retrieve
Returns:
the ith ID


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2337 UTC