OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.DirectorySearchSession
Implementsosid.filing.DirectoryQuerySession
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.

MethodgetDirectorySearch
Description

Gets a diectory search.

Returnosid.filing.DirectorySearchthe directory search
CompliancemandatoryThis method must be implemented.
MethodgetDirectorySearchOrder
Description

Gets a directory search order. The DirectorySearchOrder is supplied to a DirectorySearch to specify the ordering of results.

Returnosid.filing.DirectorySearchOrderthe directory search order
CompliancemandatoryThis method must be implemented.
MethodgetDirectoriesBySearch
Description

Gets the search results matching the given search.

Parametersosid.filing.DirectoryQuerydirectoryQuerythe directory query
osid.filing.DirectorySearchdirectorySearchthe directory search
Returnosid.filing.DirectorySearchResultsthe directory search results
ErrorsNULL_ARGUMENT directoryQuery or directorySearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED directoryQuery or directorySearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetDirectoryQueryFromInspector
Description

Gets a directory query from an inspector. The inspector is available from an DirectorySearchResults.

Parametersosid.filing.DirectoryQueryInspectordirectoryQueryInspectora query inspector
Returnosid.filing.DirectoryQuerythe directory query
ErrorsNULL_ARGUMENT directoryQueryInspector is null
UNSUPPORTED directoryQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.