org.osid.filing

Interface DirectorySearchOrder

All Superinterfaces:

DirectoryEntrySearchOrder, Extensible, OsidBrowsableSearchOrder, OsidCatalogSearchOrder, OsidExtensibleSearchOrder, OsidFederateableSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, OsidSourceableSearchOrder, Suppliable

public interface DirectorySearchOrder
extends OsidCatalogSearchOrder, DirectoryEntrySearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
DirectorySearchOrderRecord	getDirectorySearchOrderRecord(Type directoryRecordType) Gets the directory search order record corresponding to the given directory record Type.

Methods inherited from interface org.osid.OsidSourceableSearchOrder

getProviderSearchOrder, orderByProvider, supportsProviderSearchOrder

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

getDirectorySearchOrderRecord

DirectorySearchOrderRecord getDirectorySearchOrderRecord(Type directoryRecordType)
                                                         throws OperationFailedException

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

Parameters:

directoryRecordType - a directory record type

Returns:

the directory search order record

Throws:

NullArgumentException - directoryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(directoryRecordType) is false

Compliance:

mandatory - This method must be implemented.