OSID Logo
OSID Specifications
filing package
Version 3.0.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.SearchOrderStylestylesearch order style
ErrorsNULL_ARGUMENTstyle is null
CompliancemandatoryThis 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.TypefileRecordTypea file record type
Returnosid.filing.records.FileSearchOrderRecordthe file search order record
ErrorsNULL_ARGUMENTfileRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTEDhasRecordType(fileRecordType) is false
CompliancemandatoryThis method must be implemented.