com.plumtree.remote.search
Interface ISearchQuery

public interface ISearchQuery

Interface that provides the input information to execute the search. For example, remote system access information, query strings, as well as search output preferences, including the number of records to be skipped.

Method Summary

int	getMaxReturn() Gets the maximum number of records to return per page.
int	getNumberToSkip() Gets the number of records to skip; this is where the search starts.
NamedValueMap	getSearchInfo() Gets a NamedValueMap of preferences from Service Configuration Interface (SCI) pages for the Search service.
ISearchResult	getSearchResult() Gets the ISearchResult passed from IRemoteSearch to be filled in with a result set.
java.lang.String	getSearchString() Gets the search query string.
UserInfoMap	getUserInfo() Gets a UserInfoMap of User Information settings (e-mail, manager, etc.).
NamedValueMap	getUserPrefs() Gets a NamedValueMap of User preferences (user-specific configuration settings).

Method Detail

getMaxReturn

public int getMaxReturn()

Gets the maximum number of records to return per page.

Returns:

int maximum number of records to return per page

getNumberToSkip

public int getNumberToSkip()

Gets the number of records to skip; this is where the search starts.

Returns:

int number of records to skip

getSearchInfo

public NamedValueMap getSearchInfo()

Gets a NamedValueMap of preferences from Service Configuration Interface (SCI) pages for the Search service. The map will be empty if no SCI pages have been added for the Search service. Note: The names in the NamedValueMap will be uppercase.

Returns:

a NamedValueMap of preferences from Service Configuration Interface (SCI) pages

getSearchResult

public ISearchResult getSearchResult()

Gets the ISearchResult passed from IRemoteSearch to be filled in with a result set.

Returns:

the ISearchResult passed from IRemoteSearch

getSearchString

public java.lang.String getSearchString()

Gets the search query string.

Returns:

string

getUserInfo

public UserInfoMap getUserInfo()

Gets a UserInfoMap of User Information settings (e-mail, manager, etc.).

Returns:

a UserInfoMap of User Information settings

getUserPrefs

public NamedValueMap getUserPrefs()

Gets a NamedValueMap of User preferences (user-specific configuration settings).

Returns:

a NamedValueMap of User preferences