org.eaglei.ui.gwt.search
Class SearchContext

java.lang.Object
  org.eaglei.ui.gwt.search.SearchContext

All Implemented Interfaces:

SessionContext.SessionListener

public class SearchContext
extends java.lang.Object
implements SessionContext.SessionListener

Nested Class Summary

static interface

SearchContext.SearchListener

Field Summary

static SearchContext	INSTANCE
static SearchServiceRemoteAsync	searchService

Method Summary

void	addListener(SearchContext.SearchListener listener)
void	clearSearch() Clears any current or pending search request.
org.eaglei.search.provider.SearchRequest	getCurrentRequest()
ClientSearchResultSet	getCurrentResults()
boolean	isPending()
void	onLogIn()
void	onLogOut()
void	search(org.eaglei.search.provider.SearchRequest request) Executes a search if request is non-null.
void	search(org.eaglei.search.provider.SearchRequest request, boolean isTypeCategoryChange, boolean isPageRequest) Executes a search if request is non-null.
void	setCurrentRequest(org.eaglei.search.provider.SearchRequest request) Sets a request in the context, but doesn't invoke a search.

Methods inherited from class java.lang.Object

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

Field Detail

searchService

public static final SearchServiceRemoteAsync searchService

INSTANCE

public static final SearchContext INSTANCE

Method Detail

addListener

public void addListener(SearchContext.SearchListener listener)

isPending

public boolean isPending()

getCurrentRequest

public org.eaglei.search.provider.SearchRequest getCurrentRequest()

getCurrentResults

public ClientSearchResultSet getCurrentResults()

setCurrentRequest

public void setCurrentRequest(org.eaglei.search.provider.SearchRequest request)

Sets a request in the context, but doesn't invoke a search.

Parameters:

request -

clearSearch

public void clearSearch()

Clears any current or pending search request.

search

public void search(org.eaglei.search.provider.SearchRequest request)

Executes a search if request is non-null.

search

public void search(org.eaglei.search.provider.SearchRequest request,
                   boolean isTypeCategoryChange,
                   boolean isPageRequest)

Executes a search if request is non-null. isTypeCategoryChange indicates to search listeners that the pending search request probably does not involve a change in the type category of the TypeBinding in the search request. This allows certain listeners to avoid updating type category controls while the search is pending. The value of this parameter is advisory only. If set to false, and the search ultimately does involve a type category change, there should be no harm. The real type category will be indicated in the ClientSearchResultSet, and controls should respect that setting when the search result is received. isPageRequest indicates that the only difference between this request and the previously executed request is a change in the start index. The isPageRequest param is a performance optimization only, no validation is performed. Do not set it to true unless you are absolutely sure that the previous request is the same as this one except for start index. Setting it to false when the request is in fact a pagination operation should cause no harm.

Parameters:

request -

onLogIn

public void onLogIn()

Specified by:

onLogIn in interface SessionContext.SessionListener

onLogOut

public void onLogOut()

Specified by:

onLogOut in interface SessionContext.SessionListener