OSID Logo
OSID Specifications
filing package
Version 3.1.0
Interfaceosid.filing.FileSearchResults
Implementsosid.OsidSearchResults
Used Byosid.filing.FileSearchSession
Description

This interface provides a means to capture results of a search.

MethodgetFiles
Description

Gets the file list resulting from a search.

Returnosid.filing.FileList the directory list
ErrorsILLEGAL_STATE list already retrieved
Compliancemandatory This method must be implemented.
MethodgetFileQueryInspector
Description

Gets the inspector for the query to examine the terms used in the search.

Returnosid.filing.FileQueryInspector the query inspector
Compliancemandatory This method must be implemented.
MethodgetFileSearchResultsRecord
Description

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

Parametersosid.type.TypefileSearchRecordType a file search record type
Returnosid.filing.records.FileSearchResultsRecord the file search results record
ErrorsNULL_ARGUMENT fileSearchRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(fileSearchRecordType) is false
Compliancemandatory This method must be implemented.