OSID Logo
OSID Specifications
filing package
Version 3.1.0
Interfaceosid.filing.DirectorySearch
Implementsosid.OsidSearch
Used Byosid.filing.DirectorySearchSession
Description

The search interface for gioverning directory searches.

An example to find directories whose name is "Library" sorted by the path name.

DirectoryQuery query = session.getDirectoryQuery();
query.addNameMatch("Library", wordStringMatchType, true);

DirectorySearch search = session.getDirectorySearch();
search.orderByPath();

DirectorySearchResults results = session.getDirectoriesBySearch(query, search);
DirectoryList directories = results.getDirectories();
                
MethodsearchAmongDirectories
Description

Execute this search among the given list of diectories.

Parametersosid.id.IdListdirectoryIds list of directory Ids
ErrorsNULL_ARGUMENT directoryIds is null
Compliancemandatory This method must be implemented.
MethodorderDirectoryResults
Description

Specify an ordering to the search results.

Parametersosid.filing.DirectorySearchOrderdirectorySearchOrder directory search order
ErrorsNULL_ARGUMENT directorySearchOrder is null
UNSUPPORTED directorySearchOrder is not of this service
Compliancemandatory This method must be implemented.
MethodgetDirectorySearchRecord
Description

Gets the directory search record corresponding to the given directory search record Type. This method is used to retrieve an object implementing the requested record.

Parametersosid.type.TypedirectorySearchRecordType a directory search record type
Returnosid.filing.records.DirectorySearchRecord the directory search record
ErrorsNULL_ARGUMENT directorySearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(directorySearchRecordType) is false
Compliancemandatory This method must be implemented.