OSID - osid.filing.FileSearchSession Service Interface Definition

Interface	osid.filing.FileSearchSession
Implements	`osid.filing.FileQuerySession`
Used By	`osid.filing.FilingManager`
Used By	`osid.filing.FilingProxyManager`
Description	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	getFileSearch
Description	Gets a file search.
Return	`osid.filing.FileSearch`		the file search
Compliance	`mandatory`		This method must be implemented.
Method	getFileSearchOrder
Description	Gets a file search order. The `FileSearchOrder` is supplied to a `FileSearch` to specify the ordering of results.
Return	`osid.filing.FileSearchOrder`		the file search order.
Compliance	`mandatory`		This method must be implemented.
Method	getFilesBySearch
Description	Gets the search results matching the given search query using the given search.
Parameters	`osid.filing.FileQuery`	`fileQuery`	the file query
Parameters	`osid.filing.FileSearch`	`fileSearch`	the file search
Return	`osid.filing.FileSearchResults`		the file search results
Errors	NULL_ARGUMENT		`fileQuery` or `fileSearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`fileQuery` or `fileSearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getFileQueryFromInspector
Description	Gets a file query from an inspector. The inspector is available from a `FileSearchResults` .
Parameters	`osid.filing.FileQueryInspector`	`fileQueryInspector`	a query inspector
Return	`osid.filing.FileQuery`		the file query
Errors	NULL_ARGUMENT		`fileQueryInspector` is `null`
Errors	UNSUPPORTED		`fileQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.