Interface FileSearchSession

All Superinterfaces:

AutoCloseable, Closeable, FileQuerySession, OsidSession, OsidSession

public interface FileSearchSession
extends FileQuerySession

This session provides methods for searching among files and directories objects. The search query is constructed using a FileQuery .

getFilesByQuery() is the basic search method and returns a list of Files . A more advanced search may be performed with getFilesBySearch() . It accepts a FileSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getFilesBySearch() returns an FileSearchResults that can be used to access the resulting FileList or be used to perform a search within the result set through FileSearch .

This session defines views that offer differing behaviors when retrieving multiple objects.

• federated directory view: searches include entries in directories of which this directory is an ancestor
• isolated directory view: searches are restricted this directory only

Method Summary

Modifier and Type	Method	Description
FileQuery	getFileQueryFromInspector(FileQueryInspector fileQueryInspector)	Gets a file query from an inspector.
FileSearchResults	getFilesBySearch(FileQuery fileQuery, FileSearch fileSearch)	Gets the search results matching the given search query using the given search.
FileSearch	getFileSearch()	Gets a file search.
FileSearchOrder	getFileSearchOrder()	Gets a file search order.

Methods inherited from interface Closeable

close

Methods inherited from interface FileQuerySession

canSearchFiles, getDirectory, getDirectoryId, getFileQuery, getFilesByQuery, useFederatedDirectoryView, useIsolatedDirectoryView

Modifier and Type	Method	Description
boolean	canSearchFiles()	Tests if this user can perform File searches.
Directory	getDirectory()	Gets the directory associated with this session.
Id	getDirectoryId()	Gets the Id of this directory.
FileQuery	getFileQuery()	Gets a file query.
FileList	getFilesByQuery(FileQuery fileQuery)	Gets a list of Files matching the given file query.
void	useFederatedDirectoryView()	Federates the view for methods in this session.
void	useIsolatedDirectoryView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getFileSearch

FileSearch getFileSearch()

Gets a file search.

Returns:

the file search

Compliance:

mandatory - This method must be implemented.

getFileSearchOrder

FileSearchOrder getFileSearchOrder()

Gets a file search order. The FileSearchOrder is supplied to a FileSearch to specify the ordering of results.

Returns:

the file search order.

Compliance:

mandatory - This method must be implemented.

getFilesBySearch

FileSearchResults getFilesBySearch(FileQuery fileQuery,
 FileSearch fileSearch)
                            throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

fileQuery - the file query

fileSearch - the file search

Returns:

the file search results

Throws:

NullArgumentException - fileQuery or fileSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - fileQuery or fileSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getFileQueryFromInspector

FileQuery getFileQueryFromInspector(FileQueryInspector fileQueryInspector)

Gets a file query from an inspector. The inspector is available from a FileSearchResults .

Parameters:

fileQueryInspector - a query inspector

Returns:

the file query

Throws:

NullArgumentException - fileQueryInspector is null

UnsupportedException - fileQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.