OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.DirectorySearch
Implementsosid.OsidSearch
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.IdListdirectoryIdslist of directory Ids
ErrorsNULL_ARGUMENT directoryIds is null
CompliancemandatoryThis method must be implemented.
MethodorderDirectoryResults
Description

Specify an ordering to the search results.

Parametersosid.filing.DirectorySearchOrderdirectorySearchOrderdirectory search order
ErrorsNULL_ARGUMENT directorySearchOrder is null
UNSUPPORTED directorySearchOrder is not of this service
CompliancemandatoryThis 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.TypedirectorySearchRecordTypea directory search record type
Returnosid.filing.records.DirectorySearchRecordthe directory search record
ErrorsNULL_ARGUMENT directorySearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(directorySearchRecordType) is false
CompliancemandatoryThis method must be implemented.