OSID Logo
OSID Specifications
filing package
Version 3.0.0
Interfaceosid.filing.FileSearch
Implementsosid.OsidSearch
Used Byosid.filing.FileSearchSession
Description

The search interface for governing file searches.

MethodsearchAmongFiles
Description

Execute this search among the given list of files.

Parametersosid.id.IdListfileIdslist of file Ids
ErrorsNULL_ARGUMENTfileIds is null
CompliancemandatoryThis method must be implemented.
MethodorderFileResults
Description

Specify an ordering to the search results.

Parametersosid.filing.FileSearchOrderfileSearchOrderfile search order
ErrorsNULL_ARGUMENTfileSearchOrder is null
UNSUPPORTEDfileSearchOrder is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetFileSearchRecord
Description

Gets the file search 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.FileSearchRecordthe file search record
ErrorsNULL_ARGUMENTfileSearchRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(fileSearchRecordType) is false
CompliancemandatoryThis method must be implemented.