Package com.portal.search

Class SearchEvent

java.lang.Object

java.util.EventObject

com.portal.search.SearchEvent

All Implemented Interfaces:

Serializable

public class SearchEvent
extends EventObject

SearchEvent is used to notify listeners with search information, such as items found, result headers, search progress, help notification and search errors.

Version:

%version%

Author:

Larry Lynch-Freshner, Monica Gaines

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ERROR_IN_SEARCH	Delivered to indicate errors in the search.
static final int	HELP_REQUEST	Delivered to indicate a help request.
static final int	ITEMS_FOUND	Delivered when items are found in the search.
static final int	RESULT_LABELS	Delivered to indicate the result header labels.
static final int	SEARCH_PROGRESS	Delivered to indicate the progress of the search.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor	Description
SearchEvent(Object source, int type, Object data)

Method Summary

Modifier and Type	Method	Description
Object	getData()	Returns useful data from the search, for example the results of the search.
boolean	getReadFields()	Indicates whether or not a READ_FLDS needs to be performed on a search result.
ResultData[]	getResultData()	Returns the data for the results returned in the search.
String[]	getResultLabels()	Returns the labels for the results returned in the search.
int	getSortIndex()	Returns the index for the ResultData which is used in sorting by.
int	getType()	Returns the event type.
void	setReadFields(boolean b)	Sets the readFields property to indicate that an alternate field is set for the search results.
void	setResultData(ResultData[] data)	Sets the data for the results returned in the search.
void	setResultLabels(String[] labels)	Sets the labels for the results returned in the search.
void	setSortIndex(int index)	Sets the index to sort the results data.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Details

ITEMS_FOUND

public static final int ITEMS_FOUND

Delivered when items are found in the search.

See Also:

• Constant Field Values

SEARCH_PROGRESS

public static final int SEARCH_PROGRESS

Delivered to indicate the progress of the search.

See Also:

• Constant Field Values

HELP_REQUEST

public static final int HELP_REQUEST

Delivered to indicate a help request.

See Also:

• Constant Field Values

ERROR_IN_SEARCH

public static final int ERROR_IN_SEARCH

Delivered to indicate errors in the search.

See Also:

• Constant Field Values

RESULT_LABELS

public static final int RESULT_LABELS

Delivered to indicate the result header labels.

See Also:

• Constant Field Values

Constructor Details

SearchEvent

public SearchEvent(Object source,
 int type,
 Object data)

Method Details

getType

public int getType()

Returns the event type.

getData

public Object getData()

Returns useful data from the search, for example the results of the search.

getResultLabels

public String[] getResultLabels()

Returns the labels for the results returned in the search.

setResultLabels

public void setResultLabels(String[] labels)

Sets the labels for the results returned in the search.

Parameters:

labels - the labels for the results

getResultData

public ResultData[] getResultData()

Returns the data for the results returned in the search.

setResultData

public void setResultData(ResultData[] data)

Sets the data for the results returned in the search.

Parameters:

data - the result data

getSortIndex

public int getSortIndex()

Returns the index for the ResultData which is used in sorting by.

setSortIndex

public void setSortIndex(int index)

Sets the index to sort the results data.

Parameters:

index - the index of the ResultData object to use for sorting

setReadFields

public void setReadFields(boolean b)

Sets the readFields property to indicate that an alternate field is set for the search results.

Parameters:

b - set to true if an alternate field is defined for the results

getReadFields

public boolean getReadFields()

Indicates whether or not a READ_FLDS needs to be performed on a search result.