OSID - osid.filing.DirectorySearchSession Service Interface Definition

Interface	osid.filing.DirectorySearchSession
Implements	`osid.filing.DirectoryQuerySession`
Used By	`osid.filing.FilingManager`
Used By	`osid.filing.FilingProxyManager`
Description	This session provides methods for searching among `Directory` objects. The search query is constructed using the `DirectoryQuery` . This session defines views that offer differing behaviors for searching. federated directory view: searches include directories in directories of which this directory is an ancestor isolated directory view: searches are restricted to diectories in this directory only `getDirectoriesByQuery()` is the basic search method and returns a list of `Directories` . A more advanced search may be performed with `getDirectoriesBySearch()` . It accepts a `DirectorySearch` in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. `getDirectoriesBySearch()` returns an `DirectorySearchResults` that can be used to access the resulting `DirectoryList` or be used to perform a search within the result set through `DirectorySearch` .
Method	getDirectorySearch
Description	Gets a diectory search.
Return	`osid.filing.DirectorySearch`		the directory search
Compliance	`mandatory`		This method must be implemented.
Method	getDirectorySearchOrder
Description	Gets a directory search order. The `DirectorySearchOrder` is supplied to a `DirectorySearch` to specify the ordering of results.
Return	`osid.filing.DirectorySearchOrder`		the directory search order
Compliance	`mandatory`		This method must be implemented.
Method	getDirectoriesBySearch
Description	Gets the search results matching the given search.
Parameters	`osid.filing.DirectoryQuery`	`directoryQuery`	the directory query
Parameters	`osid.filing.DirectorySearch`	`directorySearch`	the directory search
Return	`osid.filing.DirectorySearchResults`		the directory search results
Errors	NULL_ARGUMENT		`directoryQuery` or `directorySearch` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`directoryQuery` or `directorySearch` is not of this service
Compliance	`mandatory`		This method must be implemented.
Method	getDirectoryQueryFromInspector
Description	Gets a directory query from an inspector. The inspector is available from an `DirectorySearchResults` .
Parameters	`osid.filing.DirectoryQueryInspector`	`directoryQueryInspector`	a query inspector
Return	`osid.filing.DirectoryQuery`		the directory query
Errors	NULL_ARGUMENT		`directoryQueryInspector` is `null`
Errors	UNSUPPORTED		`directoryQueryInspector` is not of this service
Compliance	`mandatory`		This method must be implemented.