OSID Logo
OSID Specifications
filing package
Version 3.1.0
Interfaceosid.filing.FileSearchOrder
Implementsosid.filing.DirectoryEntrySearchOrder
Used Byosid.filing.FileSearchSession
osid.filing.FileSmartDirectorySession
Description

An interface for specifying the ordering of search results.

MethodorderBySize
Description

Specifies a preference for ordering the results by file size.

Parametersosid.SearchOrderStylestyle search order style
ErrorsNULL_ARGUMENT style is null
Compliancemandatory This method must be implemented.
MethodgetFileSearchOrderRecord
Description

Gets the file search order record corresponding to the given file record Type. Multiple retrievals return the same underlying object.

Parametersosid.type.TypefileRecordType a file record type
Returnosid.filing.records.FileSearchOrderRecord the file search order record
ErrorsNULL_ARGUMENT fileRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(fileRecordType) is false
Compliancemandatory This method must be implemented.