com.portal.browse

Interface ResultsDisplay

All Superinterfaces:

EventListener, SearchInfoListener

All Known Implementing Classes:

EventResultsTablePanel, ResultsTablePanel

public interface ResultsDisplay
extends SearchInfoListener

An interface for BrowseWin which defines the methods needed for displaying search results.

Version:

%version: 9 % %date_modified: Fri Feb 09 15:59:15 2001 %

Author:

Monica Gaines

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVENT_TYPE Constant used to specifiy the object is an event type.
static int	OBJECT_TYPE Constant used to specifiy a generic object.

Method Summary

Modifier and Type	Method and Description
void	clearContents() Clears the display of it's contents.
void	closeContext() Closes lingering open portal context
void	displayDetails(int type) Displays the detail information of the selected object.
Hashtable	getMarkedEvents() Returns the list of marked events
HistoryItem[]	getSelectedItems() Returns an array of history items that contain poid and account information about the selected items in the display.
void	initSearchResults() Used to initialize the controller with the neccessary strings for retrieving search results.
int	itemCount() Returns the number of items displayed.
void	markAllItems() Mark all the items in the display.
void	markItem() Mark the currently selected item.
void	selectFirstItem(int i) Select/highlight the first item in the list of results.
void	setMaskFields(String[] flds) Sets the fields that need to be masked, i.e.
void	setResultData(ResultData[] data, int sortIndex, boolean b) Sets the information used for displaying the results.
void	showAllItems() Displays all the items, marked and unmarked.
boolean	showMarkedItems() Display the list of marked items
void	substituteData(Hashtable data) Substitute the given data when viewing object details.
void	unmarkAllItems() Unmark all the items.
void	unmarkItem() Unmark the currently selected item.

Methods inherited from interface com.portal.search.SearchInfoListener

getRemoteListener, progress, releaseRemoteListener, searchStarted

Field Detail

EVENT_TYPE

static final int EVENT_TYPE

Constant used to specifiy the object is an event type.

See Also:

Constant Field Values

OBJECT_TYPE

static final int OBJECT_TYPE

Constant used to specifiy a generic object.

See Also:

Constant Field Values

Method Detail

clearContents

void clearContents()

Clears the display of it's contents.

markItem

void markItem()

Mark the currently selected item.

unmarkItem

void unmarkItem()

Unmark the currently selected item.

markAllItems

void markAllItems()

Mark all the items in the display.

unmarkAllItems

void unmarkAllItems()

Unmark all the items.

initSearchResults

void initSearchResults()

Used to initialize the controller with the neccessary strings for retrieving search results.

selectFirstItem

void selectFirstItem(int i)

Select/highlight the first item in the list of results.

Parameters:

i - the type of action that should be performed on the results

showMarkedItems

boolean showMarkedItems()

Display the list of marked items

Returns:

returns false if there are no marked items to display

showAllItems

void showAllItems()

Displays all the items, marked and unmarked.

setMaskFields

void setMaskFields(String[] flds)

Sets the fields that need to be masked, i.e. there values hidden when looking at object details.

Parameters:

flds - the fields to be masked

substituteData

void substituteData(Hashtable data)

Substitute the given data when viewing object details.

Parameters:

data - the data to substitute

itemCount

int itemCount()

Returns the number of items displayed.

Returns:

the number of items displayed

getSelectedItems

HistoryItem[] getSelectedItems()

Returns an array of history items that contain poid and account information about the selected items in the display.

Returns:

an array of history items

getMarkedEvents

Hashtable getMarkedEvents()

Returns the list of marked events

Returns:

the marked events

setResultData

void setResultData(ResultData[] data,
                   int sortIndex,
                   boolean b)

Sets the information used for displaying the results.

Parameters:

data - the data defining the results to display

index - the index used for sorting

displayDetails

void displayDetails(int type)

Displays the detail information of the selected object.

Parameters:

type - type of object to display, either EVENT_TYPE or OBJECT_TYPE

closeContext

void closeContext()

Closes lingering open portal context