org.osid.filing

Interface FileSearchOrder

All Superinterfaces:

DirectoryEntrySearchOrder, Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable

public interface FileSearchOrder
extends DirectoryEntrySearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
FileSearchOrderRecord	getFileSearchOrderRecord(Type fileRecordType) Gets the file search order record corresponding to the given file record Type.
void	orderBySize(SearchOrderStyle style) Specifies a preference for ordering the results by file size.

Methods inherited from interface org.osid.filing.DirectoryEntrySearchOrder

getOwnerSearchOrder, orderByCreatedTime, orderByLastAccessTime, orderByModifiedTime, orderByName, orderByOwner, orderByPath, supportsOwnerSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Method Detail

orderBySize

void orderBySize(SearchOrderStyle style)

Specifies a preference for ordering the results by file size.

Parameters:

style - search order style

Throws:

NullArgumentException - style is null

Compliance:

mandatory - This method must be implemented.

getFileSearchOrderRecord

FileSearchOrderRecord getFileSearchOrderRecord(Type fileRecordType)
                                               throws OperationFailedException

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

Parameters:

fileRecordType - a file record type

Returns:

the file search order record

Throws:

NullArgumentException - fileRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(fileRecordType) is false

Compliance:

mandatory - This method must be implemented.