com.sas.swing.models.remotefileselector
Interface RemoteFileSearchModelInterface

All Superinterfaces:

RemoteFileServiceModelInterface

All Known Implementing Classes:

IFileServiceSearchModel, InformationServicesSearchModel, InformationServicesSearchModel2

public interface RemoteFileSearchModelInterface
extends RemoteFileServiceModelInterface

An interface describing necessary methods for remote file search models.

Since:

3.1

Method Summary

int	getFilterMatchType() Returns the currently set override of the desired search criteria.
void	setDateRange(java.util.Date startDate, java.util.Date endDate) Sets a date range to be used in the search.
void	setFilterMatchType(int filterMatch) Sets whether to override the type of desired search criteria.
void	setRecursive(boolean recursive) Sets whether to make allow subfolders to be recursively searched.
void	setSearchAttributes(java.util.Map searchAttributes) Sets all of the search attributes with one method call.
void	setSearchContext(java.lang.String context) Sets the context for searching.
void	setSearchText(java.lang.String text) Sets the text string to search.
void	setStartingLocation(java.lang.String startingLocation) Sets the file system path location where the search starts.
void	startSearch(RemoteFileServerModelInterface model, BaseActionProvider actionProvider) Runs when the search is initiated.
void	stopSearch() A method used to stop the search.

Methods inherited from interface com.sas.swing.models.remotefileselector.RemoteFileServiceModelInterface

addPropertyChangeListener, combineDirectoryPathAndFileName, getDirectoryPath, getFiles, getFilterValues, getFullyQualifiedPath, getTopLevelName, removePropertyChangeListener, setFilterValues, splitDirectoryPathAndFileName

Method Detail

startSearch

void startSearch(RemoteFileServerModelInterface model,
                 BaseActionProvider actionProvider)

Runs when the search is initiated.

Parameters:

model - the model used to hold the search results

actionProvider - the action provider

stopSearch

void stopSearch()

A method used to stop the search.

setSearchAttributes

void setSearchAttributes(java.util.Map searchAttributes)

Sets all of the search attributes with one method call.

Parameters:

searchAttributes - the search attributes

setSearchContext

void setSearchContext(java.lang.String context)

Sets the context for searching. Corresponds to the question "what column?".

Parameters:

context - the search context

setSearchText

void setSearchText(java.lang.String text)

Sets the text string to search. The default search does a contains on the text string, so specifying a wildcard string *text* is not necessary.

Parameters:

text - the text to search

setStartingLocation

void setStartingLocation(java.lang.String startingLocation)

Sets the file system path location where the search starts.

Parameters:

startingLocation - the file system path

setRecursive

void setRecursive(boolean recursive)

Sets whether to make allow subfolders to be recursively searched.

Parameters:

recursive - specifies whether to search subfolders

setDateRange

void setDateRange(java.util.Date startDate,
                  java.util.Date endDate)

Sets a date range to be used in the search.

Parameters:

startDate - the beginning date (inclusive)

endDate - the ending date (inclusive)

setFilterMatchType

void setFilterMatchType(int filterMatch)

Sets whether to override the type of desired search criteria. This will override any setting specified through wildcards in the search text.

Parameters:

filterMatch - the filter match type

See Also:

getFilterMatchType(), FilterComponent

getFilterMatchType

int getFilterMatchType()

Returns the currently set override of the desired search criteria.

Returns:

the desired search criteria

See Also:

setFilterMatchType(int)