OSID Logo
OSID Specifications
filing package
Version 3.0.0
Release Candidate Preview
Interfaceosid.filing.FileSearchResults
Implementsosid.OsidSearchResults
Description

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

MethodgetFiles
Description

Gets the file list resulting from a search.

Returnosid.filing.FileListthe directory list
ErrorsILLEGAL_STATElist already retrieved
CompliancemandatoryThis method must be implemented.
MethodgetFileQueryInspector
Description

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

Returnosid.filing.FileQueryInspectorthe query inspector
CompliancemandatoryThis 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.TypefileSearchRecordTypea file search record type
Returnosid.filing.records.FileSearchResultsRecordthe file search results record
ErrorsNULL_ARGUMENT fileSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(fileSearchRecordType) is false
CompliancemandatoryThis method must be implemented.